Setup Cached Context AI SDLC framework - #835
Open
clintoncwolfe wants to merge 2 commits into
Open
Conversation
Signed-off-by: Clinton Wolfe <156460+clintoncwolfe@users.noreply.github.com>
…ncy check Signed-off-by: Clinton Wolfe <156460+clintoncwolfe@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
There are a few concrete documentation/config issues (notably .ruby-version being ignored while referenced, plus workflow step numbering inconsistencies) that should be corrected to avoid confusing or breaking the intended setup flow.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR sets up an initial “cached context” AI SDLC scaffold for the Train repo by adding Copilot Skills, local context/standards documents, and helper configuration/scripts to bootstrap shared context and reference repositories.
Changes:
- Added Copilot Skills for
/start-developmentand/search-context, plus supporting config/script scaffolding. - Introduced local context standards/advice documents under
context/local/and updated.github/copilot-instructions.mdto point at them. - Added defaults for shared-context + reference repo cloning (
etc/env.default.sh,etc/reference-repo-list.txt) and updated.gitignoreaccordingly.
File summaries
| File | Description |
|---|---|
etc/reference-repo-list.txt |
Adds a default set of reference repositories to clone for AI-assisted development. |
etc/env.default.sh |
Provides default environment variables for shared context location and Chef license acceptance. |
context/local/standards/workflow.md |
Adds a detailed workflow document (JIRA + testing + PR flow + AI compliance checklist). |
context/local/standards/testing.md |
Adds local testing standards and examples (Minitest + SimpleCov guidance). |
context/local/standards/coding-standards.md |
Adds local Ruby/ChefStyle coding standards guidance. |
context/local/advice/transport-development.md |
Adds brief transport development guidance for Train plugin work. |
context/local/advice/platform-support.md |
Adds brief platform support guidance. |
.vscode/mcp.json |
Adds VS Code MCP server configuration for Atlassian/JIRA integration. |
.gitignore |
Ignores generated/cloned context directories and local env file(s). |
.github/skills/start-development/SKILL.md |
Defines the bootstrap skill to set up shared context, reference repos, Ruby, and Bundler. |
.github/skills/search-context/SKILL.md |
Defines the skill to navigate/search the shared/local context structure. |
.github/scripts/bundle-install.sh |
Adds a wrapper script to run Bundler with problematic git env vars cleared. |
.github/copilot-instructions.md |
Refactors the main Copilot instructions to rely on /start-development and /search-context plus local standards. |
Review details
- Files reviewed: 12/13 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+47
to
+61
| ```bash | ||
| grep -r context/shared/global/progress/background/**/*.md 'string' | ||
| grep -r context/shared/by-business-unit/infra/background/**/*.md 'string' | ||
| grep -r context/shared/by-division/chef/background/**/*.md 'string' | ||
| grep -r context/shared/by-product/chef-infra-client/background/**/*.md 'string' | ||
| grep -r context/shared/by-repo/chef/chef/background/**/*.md 'string' | ||
| ``` | ||
|
|
||
| ```bash | ||
| grep -r context/shared/global/progress/standards/**/*.md 'string' | ||
| grep -r context/shared/by-business-unit/infra/standards/**/*.md 'string' | ||
| grep -r context/shared/by-division/next/standards/**/*.md 'string' | ||
| grep -r context/shared/by-product/alsi/standards/**/*.md 'string' | ||
| grep -r context/local/standards/**/*.md 'string' | ||
| ``` |
|
|
||
| 1. Policy specifications higher in the tree are more influential. So a division-level standard should generally apply more than a product-level standard. | ||
| 2. Technical specifications lower in the tree override specs context higher in the tree. So a technical specification to use a particular driver api might be needed for a good reason (which must be justified) and this override a higher-level mandate. | ||
| 3. Any confusion or unresolved issues should be brough to the user's attention for a decision. |
Comment on lines
+238
to
+246
| This AI compliance checklist should be integrated into the main development workflow Step 4 (Pull Request Creation): | ||
|
|
||
| Step 4: Pull Request Creation & AI Compliance | ||
| - Step 4.1: Create branch and commit changes | ||
| - Step 4.2: Push changes to remote | ||
| - Step 4.3: Create PR with ai-assisted label | ||
| - Step 4.4: IMMEDIATELY update Jira customfield_11170 to "Yes" | ||
| - Step 4.5: Verify both PR labels and Jira field are properly set | ||
| - Step 4.6: Provide complete summary including AI compliance confirmation |
| @@ -0,0 +1,19 @@ | |||
| # This file lists GitHub repos to clone as reference material for AI-assisted development. | |||
| # Edit this list to add repos relevant to your specific resource pack domain. | |||
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.
Setup skeletons for cached context AI development. Refectors copilot-instructions into smaller pieces. Adds /start-development skill and make it mandatory. Adds /search-context skill. Adds a default reference-repo list.