Skip to content

docs: add guidance for populating project-level context #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TabishB merged 2 commits into from
Oct 26, 2025
Merged

docs: add guidance for populating project-level context #241

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f18aad
docs: add optional project context setup instructions
harikrishnan83 Oct 26, 2025
10e1c8a
docs: improve project context section formatting and clarity
harikrishnan83 Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,17 @@ openspec init
- If your coding assistant doesn't surface the new slash commands right away, restart it. Slash commands are loaded at startup,
so a fresh launch ensures they appear

### Optional: Populate Project Context

After `openspec init` completes, you'll receive a suggested prompt to help populate your project context:

```text
Populate your project context:
"Please read openspec/project.md and help me fill it out with details about my project, tech stack, and conventions"
```

Use `openspec/project.md` to define project-level conventions, standards, architectural patterns, and other guidelines that should be followed across all changes.
Copy link
Contributor

@TabishB TabishB Oct 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I need to re-think about having or adding conventions here. I feel this maybe collides with what is expected to be in an AGENTS.md or CLAUDE.md file usually so we might be replicating conventions across multiple docs.

Copy link
Contributor Author

@harikrishnan83 harikrishnan83 Oct 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Thanks.


### Create Your First Change

Here's a real example showing the complete OpenSpec workflow. This works with any AI tool. Those with native slash commands will recognize the shortcuts automatically.
Expand Down
Loading