Skip to content

Commit a665807

Browse files
docs: add guidance for populating project-level context (#241)
* docs: add optional project context setup instructions Add documentation for the optional step of populating project.md with project details, tech stack, and conventions after running openspec init. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * docs: improve project context section formatting and clarity - Change heading to "Optional: Populate Project Context" for consistency - Fix double space typo in "After openspec init" - Explicitly reference openspec/project.md file - Enhance explanation of project.md purpose 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent fb1d37e commit a665807

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,17 @@ openspec init
153153
- If your coding assistant doesn't surface the new slash commands right away, restart it. Slash commands are loaded at startup,
154154
so a fresh launch ensures they appear
155155

156+
### Optional: Populate Project Context
157+
158+
After `openspec init` completes, you'll receive a suggested prompt to help populate your project context:
159+
160+
```text
161+
Populate your project context:
162+
"Please read openspec/project.md and help me fill it out with details about my project, tech stack, and conventions"
163+
```
164+
165+
Use `openspec/project.md` to define project-level conventions, standards, architectural patterns, and other guidelines that should be followed across all changes.
166+
156167
### Create Your First Change
157168

158169
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.

0 commit comments

Comments
 (0)