Add blueprint and reference implementation guidance docs - #400
danielgblanco merged 3 commits into
Conversation
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Pull request overview
This PR extracts embedded guidance from the blueprint/reference-implementation templates into standalone authoring-guideline docs, and updates GitHub issue templates to point contributors to those guidelines (closing #348).
Changes:
- Moved template guidance into
architecture/blueprint-guidelines.mdandarchitecture/reference-implementation-guidelines.md. - Simplified the blueprint and reference-implementation templates to link to the new guideline docs.
- Updated issue templates to link to the new guidelines for visibility.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| architecture/reference-implementation-template.md | Replaces large embedded guidance comment blocks with a link to new authoring guidelines. |
| architecture/reference-implementation-guidelines.md | Adds standalone guidance previously embedded in the reference implementation template. |
| architecture/blueprint-template.md | Replaces embedded guidance comment block with a link to new blueprint authoring guidelines. |
| architecture/blueprint-guidelines.md | Adds standalone guidance previously embedded in the blueprint template, plus extended best practices. |
| .github/ISSUE_TEMPLATE/reference_implementation.yml | Adds a link to the new reference implementation guidelines in the issue form text. |
| .github/ISSUE_TEMPLATE/blueprint_proposal.yml | Adds a link to the new blueprint guidelines in the issue form text. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
This is a good cleanup, @danielgblanco! It keeps the templates focused, moves detailed guidance into discoverable documents, and links the issue forms to both the template and the authoring guidance. I left one minor wording suggestion; otherwise, this looks good to me. |
|
LGTM! |
Closes #348
Changes: