Skip to content

docs: require PR review and full local tests before merge - #56

Merged
ArianAr merged 2 commits into
mainfrom
docs/pr-review-and-test-process
Jul 15, 2026
Merged

docs: require PR review and full local tests before merge#56
ArianAr merged 2 commits into
mainfrom
docs/pr-review-and-test-process

Conversation

@ArianAr

@ArianAr ArianAr commented Jul 15, 2026

Copy link
Copy Markdown
Owner

Summary

Process fix from maintainer feedback: every change must be tested and every PR must get a review before merge.

  • New AGENTS.md — durable agent/maintainer workflow
  • CONTRIBUTING.md — steps 4–8 spell out local gates, review, then merge

Test plan

  • Docs-only change (no code paths)
  • Read-through for accuracy against actual CI jobs

Codify agent/maintainer workflow: one PR per issue, run CI-equivalent
checks on every change, and complete a code review before merging.
@ArianAr ArianAr added documentation Improvements or additions to documentation area:docs README, CHANGELOG, SECURITY, guides labels Jul 15, 2026
Use Closes/Fixes interchangeably in the PR checklist so it matches the
workflow step that prefers Closes #N.

@ArianAr ArianAr left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Review (docs process)

Summary: Clean docs PR codifying test-every-change + review-before-merge for agents and humans. AGENTS.md matches CI jobs and privacy defaults.

Issue counts: 0 bugs, 0 suggestions, 1 nit (fixed on branch).

Nit (resolved)

  • CONTRIBUTING.md mixed Closes #N vs Fixes #123 — follow-up commit aligns the PR checklist to accept either form.

Verdict: LGTM once CI green.

@ArianAr
ArianAr merged commit d2581ed into main Jul 15, 2026
9 of 10 checks passed
@ArianAr
ArianAr deleted the docs/pr-review-and-test-process branch July 15, 2026 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs README, CHANGELOG, SECURITY, guides documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant