Skip to content

docs(contributing): require the five-part description for every PR - #17

Merged
fang2hou merged 1 commit into
mainfrom
docs/pr-descriptions
Aug 20, 2026
Merged

fang2hou merged 1 commit into
mainfrom
docs/pr-descriptions

Conversation

@fang2hou

Copy link
Copy Markdown
Owner

Purpose

Align CONTRIBUTING.md with the updated shared guidelines (project-documentation v7): the five-part description requirement now applies to every pull request, with no AI-specific framing.

Impact

  • CONTRIBUTING.md: section AI-Assisted Pull Requests renamed to Pull Request Descriptions; the "AI-generated or AI-assisted PRs are welcome…" framing line is replaced by the uniform "Every pull request description must clearly include:". The five items and the template-sync sentence are unchanged.
  • The line-4 cross-reference to AGENTS.md stays: it points at the agent-facing doc, not a PR labeling policy.

Context

Guidelines commit b08322f (docs(practices): require uniform PR descriptions without AI labeling, rainzm#22). Found by the audit run against b08322f.

Risks

None — documentation only.

Testing

mise run check — pass (oxfmt clean).

Follows project-documentation v7: the description requirements are
uniform for all pull requests and carry no AI labeling.
@fang2hou
fang2hou merged commit e1f4fea into main Aug 20, 2026
2 checks passed
@fang2hou
fang2hou deleted the docs/pr-descriptions branch August 20, 2026 15:41
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.

1 participant