Skip to content

Docs contributing#10

Merged
BENZOOgataga merged 4 commits into
mainfrom
docs-contributing
Feb 15, 2026
Merged

Docs contributing#10
BENZOOgataga merged 4 commits into
mainfrom
docs-contributing

Conversation

@BENZOOgataga
Copy link
Copy Markdown
Member

This pull request introduces two major improvements: it adds a comprehensive CONTRIBUTING.md guide 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:

  • Added a detailed CONTRIBUTING.md file outlining development setup, maintenance mode, release note guidelines, testing, code style, database changes, security, and a PR checklist.
  • Added a release note for the new contributing documentation. (.releases/unreleased/docs-contributing.md)

Continuous Integration enhancements:

  • Introduced a "Verify Gate" job in .github/workflows/verify.yml that always runs, summarizes the outcome of verification jobs, and provides a single status check for branch protection.
  • Set explicit permissions: read for workflow contents to improve security in CI.
  • Added a release note for the new CI verify gate job. (.releases/unreleased/ci-verify-gate-job.md)

BENZOOgataga and others added 3 commits February 15, 2026 02:39
…n permissions

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 15, 2026 02:20
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Feb 15, 2026

Greptile Overview

Greptile Summary

This PR adds comprehensive contributing documentation (CONTRIBUTING.md) and improves CI reliability with a unified "Verify Gate" job for branch protection.

Key Changes:

  • New CONTRIBUTING.md provides clear guidance on local development setup, maintenance mode usage, release notes requirements, testing, code style, and security practices
  • CI workflow now includes a gate job that always runs and consolidates the status of changes, docs-only, and verify jobs into a single check
  • Added explicit permissions: contents: read to workflow for better security posture
  • Release notes properly document both changes following the project's release entry convention

Alignment with AGENTS.md:
The contributing guide accurately reflects the golden rules defined in docs/agents/AGENTS.md, including maintenance mode requirements (Golden Rule #1), release entry requirements (Golden Rule #2), local-only commits (Golden Rule #3), and testing expectations. The documentation provides contributors with a clear path to follow project conventions.

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk - it adds documentation and improves CI workflow reliability without changing application code.
  • The changes are purely additive: new documentation file and enhanced CI workflow logic. The gate job implementation correctly handles the three possible states (changes detection, docs-only path, and full verification path) with proper failure handling. Release notes follow project conventions. No application logic is modified.
  • No files require special attention

Last reviewed commit: d6d4857

@BENZOOgataga BENZOOgataga merged commit eb39e90 into main Feb 15, 2026
5 checks passed
@BENZOOgataga BENZOOgataga deleted the docs-contributing branch February 15, 2026 02:22
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants