docs: supercharge repository AI-readiness (automated) - #1589
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟡 Not ready to approve
repo-context.md includes inaccurate dependency and sample-authoring guidance that should be corrected to avoid misleading contributors and agents.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR adds repository-wide documentation and scoped instruction files intended to improve AI-readiness by capturing repo context, contribution workflow, agent guardrails, and per-area editing guidance.
Changes:
- Added new repo documentation:
repo-context.md,CONTRIBUTING.md, andAGENTS.md. - Added a PR template plus scoped instructions under
.github/instructions/for tests, content catalogs, and CI workflow edits. - Updated
README.mdto link to the new docs and guidance resources; expanded.gitignorewith common secret/artifact patterns.
File summaries
| File | Description |
|---|---|
| repo-context.md | New repository-context doc (structure, CI/CD, conventions); contains a couple of factual mismatches with existing repo content. |
| README.md | Adds links to CONTRIBUTING and a documentation index table for new guidance files. |
| CONTRIBUTING.md | New contributor quick-start, workflow, pitfalls, and validated test command guidance. |
| AGENTS.md | New agent-facing operational context, safety guardrails, secrets guidance, and test-selection examples. |
| .gitignore | Adds patterns to avoid committing common env/secret/cert files. |
| .github/pull_request_template.md | New PR template to standardize PR descriptions, testing info, and checks. |
| .github/instructions/tests.instructions.md | New scoped instructions for changes under tests/**. |
| .github/instructions/content.instructions.md | New scoped instructions for content catalog changes (sample-queries/permissions/messages/ge-tour). |
| .github/instructions/ci-workflows.instructions.md | New scoped instructions for GitHub Actions workflow edits. |
Review details
- Files reviewed: 8/9 changed files
- Comments generated: 2
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
@microsoft-github-policy-service agree company="Microsoft" |
- Mark jest and node-fetch as declared in package.json devDependencies (they were incorrectly listed as 'Not declared in this repository'). - Align humanName guidance with the canonical README rule (small caps only / all lowercase) instead of the ambiguous 'lowercased at the first word'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Ready to approve
The changes are documentation and repo-guidance additions that align with the existing CI/CD configuration and repository conventions, with no functional code changes requiring further validation.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Review details
- Files reviewed: 8/9 changed files
- Comments generated: 0 new
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
Resolved |
There was a problem hiding this comment.
🟢 Ready to approve
The changes are documentation and guidance additions that align with existing repository structure and CI behavior, with no functional code or workflow behavior changes introduced.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Review details
- Files reviewed: 8/9 changed files
- Comments generated: 0 new
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
e4b2842
into
microsoftgraph:master
Summary
Automated AI-readiness improvements from SuperchargeAI v2.8.2.
Remaining Gaps
Generated by SuperchargeAI.