Docs contributing#10
Conversation
…n permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Greptile OverviewGreptile SummaryThis PR adds comprehensive contributing documentation ( Key Changes:
Alignment with AGENTS.md: Confidence Score: 5/5
Last reviewed commit: d6d4857 |
There was a problem hiding this comment.
Pull request overview
This pull request establishes formal contribution guidelines and improves CI reliability for the CorpSim project. It introduces comprehensive documentation for contributors covering development workflows, testing requirements, and project conventions, while also implementing a unified gate job for branch protection that ensures reliable status checks.
Changes:
- Added
CONTRIBUTING.mdwith detailed development setup, maintenance mode workflows, release note requirements, testing guidelines, code style expectations, and security best practices - Introduced a "Verify Gate" job in the CI workflow that provides a single, always-running status check for branch protection by aggregating the results of verification and docs-only jobs
- Created release note entries documenting both the new contributing documentation and CI gate job improvements
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | New comprehensive guide covering development setup (Node.js 20+, pnpm, Docker), maintenance mode workflows, release note requirements, testing/quality gates, code style expectations, database migration practices, security guidelines, and PR checklist |
| .github/workflows/verify.yml | Added top-level permissions: read for security and introduced gate job that runs with if: always() to aggregate verification outcomes from changes, docs-only, and verify jobs into a single status check |
| .releases/unreleased/docs-contributing.md | Release note documenting the addition of CONTRIBUTING.md with area "docs" and type "patch" |
| .releases/unreleased/ci-verify-gate-job.md | Release note documenting the new Verify Gate job with area "ci" and type "patch" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This pull request introduces two major improvements: it adds a comprehensive
CONTRIBUTING.mdguide to clarify contribution workflows and expectations, and it enhances CI reliability by introducing a "Verify Gate" job that unifies status checks for branch protection. Additionally, release notes entries have been created to document these changes.Documentation improvements:
CONTRIBUTING.mdfile outlining development setup, maintenance mode, release note guidelines, testing, code style, database changes, security, and a PR checklist..releases/unreleased/docs-contributing.md)Continuous Integration enhancements:
.github/workflows/verify.ymlthat always runs, summarizes the outcome of verification jobs, and provides a single status check for branch protection.permissions: readfor workflow contents to improve security in CI..releases/unreleased/ci-verify-gate-job.md)