feat(docs): add CONTRIBUTING.md contributor guide#172
Merged
Alberto-Codes merged 1 commit intomainfrom Feb 27, 2026
Merged
Conversation
New contributors and AI agents can now find clear development setup, pre-commit hooks, quality gates, commit conventions, and PR process documentation at the repo root. References docs/development-guide.md for detailed conventions instead of duplicating content. - Add CONTRIBUTING.md (163 lines, 13 sections) with fork-and-clone workflow, pre-commit hooks setup, quality gates, and key constraints - Document all 7 pre-commit hooks for the first time - Include issue reporting section with 3 template types - Link to live documentation site and development guide Test: CI only (docs-only change, no source modifications) Closes #104
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive contribution documentation by introducing CONTRIBUTING.md at the repository root, making docvet more accessible to both human contributors and AI agents. The guide consolidates previously scattered contribution guidance into a single, discoverable entry point that GitHub automatically surfaces in its UI.
Changes:
- Add CONTRIBUTING.md (163 lines, 13 sections) covering fork-and-clone workflow, development setup, pre-commit hooks, quality gates, coding standards, testing, commit conventions, PR process, issue reporting, CI pipeline, and key constraints
- Update sprint status to mark stories 22-3 and 22-4 as complete
- Add Epic 16 retrospective documenting the additive exclude configuration feature
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | New comprehensive contributor guide with development setup, quality gates, and process documentation |
| _bmad-output/implementation-artifacts/sprint-status.yaml | Mark stories 22-3 and 22-4 as done, add Epic 16 retrospective completion date |
| _bmad-output/implementation-artifacts/epic-16-retro-2026-02-27.md | New retrospective documenting successful delivery of additive exclude configuration |
| _bmad-output/implementation-artifacts/22-4-create-contributing-md-contributor-guide.md | Complete story file with implementation details and code review findings |
| _bmad-output/implementation-artifacts/22-3-create-agents-md-for-cross-tool-agent-discovery.md | Update story status and add post-merge fix note |
Alberto-Codes
added a commit
that referenced
this pull request
Feb 28, 2026
🤖 I have created a release *beep* *boop* --- ## [1.6.0](v1.5.0...v1.6.0) (2026-02-28) ### Features * **ci:** add cross-platform CI matrix and path normalization ([#174](#174)) ([e418fbc](e418fbc)), closes [#101](#101) * **ci:** add pre-commit hook definition and tests ([#180](#180)) ([5f11287](5f11287)) * **cli:** add --format json for structured machine-readable output ([#177](#177)) ([da8e51d](da8e51d)), closes [#151](#151) * **cli:** add positional file arguments to all subcommands ([#175](#175)) ([dee57cc](dee57cc)), closes [#152](#152) * **docs:** add "How to Fix" guidance to all 19 rule pages ([#166](#166)) ([817f43c](817f43c)), closes [#155](#155) * **docs:** add AGENTS.md and AI Agent Integration docs page ([#171](#171)) ([bc662a2](bc662a2)), closes [#161](#161) * **docs:** add AI Agent Integration section and enhance competitive positioning ([#170](#170)) ([df51114](df51114)), closes [#153](#153) [#162](#162) * **docs:** add CONTRIBUTING.md contributor guide ([#172](#172)) ([4ff286f](4ff286f)), closes [#104](#104) * **lsp:** add Claude Code plugin configuration ([#185](#185)) ([17be1f3](17be1f3)), closes [#63](#63) * **lsp:** add pygls-based LSP server for real-time diagnostics ([#184](#184)) ([e121c38](e121c38)), closes [#159](#159) * **reporting:** add format_json() for structured JSON output ([da8e51d](da8e51d)) ### Bug Fixes * **ci:** strengthen pre-commit hook YAML test assertions ([5f11287](5f11287)) * **docs:** code review fixes for AGENTS.md and ai-integration page ([bc662a2](bc662a2)) * **lsp:** decouple server global, narrow exception, fix handler test ([e121c38](e121c38)) ### Documentation * **cli:** document --format json schema and usage ([da8e51d](da8e51d)) * **meta:** reserve # references for GitHub issues and PRs only ([5f11287](5f11287)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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.
New contributors and AI agents can now find clear development setup,
pre-commit hooks, quality gates, commit conventions, and PR process
documentation at the repo root. Previously, contribution guidance was
scattered across CLAUDE.md, docs/development-guide.md, and the PR
template with no single entry point.
workflow, pre-commit hooks setup, quality gates, and key constraints
Test: CI only (docs-only change, no source modifications)
Closes #104
PR Review
Checklist
uv run pytest)uv run ruff check .)uv run ty check)!in title andBREAKING CHANGE:in bodyReview Focus
CONTRIBUTING.md content accuracy: fork-and-clone flow, pre-commit hooks table, quality gates commands, commit scopes list. References docs/development-guide.md rather than duplicating content.
Related