Skip to content

docs: document PR publishing requirements#6870

Merged
Xuanwo merged 2 commits into
mainfrom
xuanwo/document-pr-title-convention
May 20, 2026
Merged

docs: document PR publishing requirements#6870
Xuanwo merged 2 commits into
mainfrom
xuanwo/document-pr-title-convention

Conversation

@Xuanwo

@Xuanwo Xuanwo commented May 20, 2026

Copy link
Copy Markdown
Collaborator

Document the PR publishing requirements in AGENTS.md so agent-created PRs match the checks enforced by CI before they are opened or updated.

This records two required gates:

  • PR titles must follow Conventional Commits because .github/workflows/pr-title.yml validates the title and body with commitlint.
  • PRs must run lint checks for every touched language surface before creation or update. Rust changes require cargo fmt --all and cargo clippy --all --tests --benches -- -D warnings; Python changes require the python/AGENTS.md environment workflow and uv run make lint from python/.

If a required lint check cannot be run, the blocker must be stated explicitly in the PR summary.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 20, 2026
@Xuanwo Xuanwo marked this pull request as ready for review May 20, 2026 10:43

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

@Xuanwo Xuanwo changed the title docs: document PR title convention docs: document PR publishing requirements May 20, 2026
@Xuanwo Xuanwo merged commit 79b363a into main May 20, 2026
5 of 9 checks passed
@Xuanwo Xuanwo deleted the xuanwo/document-pr-title-convention branch May 20, 2026 10:50
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.

2 participants