Skip to content

docs(contributing): add structured PR process — issue-first, QA cycle, commit format#85

Closed
halindrome wants to merge 3 commits intoDeusData:mainfrom
halindrome:feat/contributing-mr-process
Closed

docs(contributing): add structured PR process — issue-first, QA cycle, commit format#85
halindrome wants to merge 3 commits intoDeusData:mainfrom
halindrome:feat/contributing-mr-process

Conversation

@halindrome
Copy link
Copy Markdown
Contributor

Closes #84

Summary

This PR documents the contributor workflow first demonstrated in PR #72, which the maintainer described as showing "real engineering discipline." The goal is to give future contributors a clear, reusable playbook for structuring PRs and validating their own work before submission.

Changes to CONTRIBUTING.md:

  • Commit Format section — documents the conventional commit convention (type(scope): description) already used throughout the project history, with a type reference table
  • Pull Request Guidelines — tightened to a focused technical checklist (C code only, one logical change, tests, lint)
  • Pull Request Process section — numbered 4-step submission process: open issue first → describe changes → test against a real project → QA review
  • QA Review Process — Step A/B/C cycle adapted from PR fix(store): keep WAL journal mode during bulk write to prevent DB corruption on crash #72's approach: run a fresh top-tier model session per round, fix findings in a separate commit per round (fix(scope): address QA round N), paste each report as a PR comment to prove the work. Minimum 3 rounds for logic-touching PRs. Docs-only PRs are explicitly exempt.

Notes

This PR is docs-only (changes to CONTRIBUTING.md only) and is therefore exempt from the QA round requirement per the policy being introduced.

@halindrome halindrome force-pushed the feat/contributing-mr-process branch from cc6aac9 to 5bb514c Compare March 20, 2026 21:03
shanemccarron-maker and others added 2 commits March 20, 2026 18:39
…fenced code block

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Stop early when a QA round is already clean — no confirmed critical or
major findings means no further rounds are needed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@DeusData DeusData added the documentation Improvements or additions to documentation label Mar 21, 2026
@DeusData
Copy link
Copy Markdown
Owner

Thanks @halindrome — this was a thoughtful PR. CONTRIBUTING.md was rewritten during the v0.5.5 security hardening session and now covers build setup, testing, linting, security audit, project structure, language support workflow, and PR guidelines.

The commit format table and issue-first requirement from your PR are good ideas that we may incorporate later. The QA round workflow with AI model prompts, while creative, is too prescriptive for a general CONTRIBUTING guide — different contributors use different tools.

Closing since the parent issue #84 is already resolved and the guide covers the essentials. Your PR #72 (WAL fix) remains the gold standard for how we'd like PRs structured — thanks for setting that example.

@DeusData DeusData closed this Mar 23, 2026
DeusData added a commit that referenced this pull request Mar 23, 2026
…G.md

- Commit format table: feat, fix, test, refactor, perf, docs, chore
  (adapted from @halindrome's PR #85)
- One issue per PR: no bundling multiple fixes/features
- Open an issue first: every PR must reference a tracking issue

Based on feedback from @halindrome (#84, #85) who identified the need
for structured PR guidelines and commit conventions.
Shidfar pushed a commit to hodizoda/codebase-memory-mcp that referenced this pull request Apr 8, 2026
…G.md

- Commit format table: feat, fix, test, refactor, perf, docs, chore
  (adapted from @halindrome's PR DeusData#85)
- One issue per PR: no bundling multiple fixes/features
- Open an issue first: every PR must reference a tracking issue

Based on feedback from @halindrome (DeusData#84, DeusData#85) who identified the need
for structured PR guidelines and commit conventions.
Shidfar pushed a commit to hodizoda/codebase-memory-mcp that referenced this pull request Apr 8, 2026
…G.md

- Commit format table: feat, fix, test, refactor, perf, docs, chore
  (adapted from @halindrome's PR DeusData#85)
- One issue per PR: no bundling multiple fixes/features
- Open an issue first: every PR must reference a tracking issue

Based on feedback from @halindrome (DeusData#84, DeusData#85) who identified the need
for structured PR guidelines and commit conventions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document structured PR/QA review process in CONTRIBUTING.md

3 participants