Changed the default location of project specs to specs/#70
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates Donna’s default project-level specs location to specs/ (instead of .donna/project/) and migrates repository documentation/spec artifacts to match the new layout.
Changes:
- Switched the default
projectworld filesystem path tospecs/. - Added/moved project specs into
specs/(including new core specs and work workflows). - Updated README, bundled usage specs, and changelog migration notes to reference the new location.
Reviewed changes
Copilot reviewed 5 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
donna/workspaces/config.py |
Changes default project world path to specs/. |
README.md |
Updates docs/links and default worlds description to reference specs/. |
donna/fixtures/specs/usage/worlds.md |
Updates bundled “worlds” spec to reflect project world at <project-root>/specs. |
changes/unreleased.md |
Adds migration guidance + changelog entry for the default path move. |
specs/intro.md |
Updates repo “points of interest” to include specs/ as project artifacts location. |
specs/core/top_level_architecture.md |
New architecture overview spec for the project world. |
specs/core/error_handling.md |
New error-handling specification for the project world. |
specs/work/polish.md |
Adds polishing workflow artifact (format/lint/typecheck loop). |
specs/work/log_changes.md |
Adds workflow for logging unreleased changes into the changelog. |
Comments suppressed due to low confidence (1)
specs/intro.md:50
- Typo in description: "donn-specific" should be "Donna-specific" (and likely capitalize consistently with the previous bullet).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,10 +1,14 @@ | |||
| ### Migration | |||
|
|
|||
| - Move project-specific specs from `.donna/project` to `specs`, or set an explicit `project` world path in your Donna workspace config before upgrading. | |||
There was a problem hiding this comment.
In the migration note, the destination path is formatted as specs while the rest of the PR/documentation uses specs/. Consider making this consistent (and optionally include <project-root>/specs/ to match the source path style) to reduce ambiguity.
Suggested change
| - Move project-specific specs from `.donna/project` to `specs`, or set an explicit `project` world path in your Donna workspace config before upgrading. | |
| - Move project-specific specs from `.donna/project` to `<project-root>/specs/`, or set an explicit `project` world path in your Donna workspace config before upgrading. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.