pull-requests
Skill325 starsChanged 7 days agoApache-2.0View on GitHub
Rules for preparing pull requests and commits in the Quarkus project: title conventions, description format, commit hygiene, labels, and contribution policies.
16 other projects use a version of this; 1 new project in the last 4 weeks, against 0 the 4 before.
Adopted by
Surging: 1 new project took it in the last 4 weeks, none the 4 weeks before.thin data
Most recently taken up by
- Livinglist/Hackitheir own version, first seen Nov 16, 2026
- profdorly/ultimate-dev-skillstheir own version, first seen Nov 8, 2026
- pluk-inc/md-preview.apptheir own version, first seen Nov 2, 2026
- pluk-inc/markdown-previewtheir own version, first seen Nov 1, 2026
- lambdakilo/dotclaudetheir own version, first seen Nov 1, 2026
- Astatide1337/Skillstheir own version, first seen Oct 20, 2026
Other versions16 projects use a version of this.
Word for word · 1
- quarkusio/quarkus★ 16k100% same
Edited · 0
None found.
Wrote their own version · 15
- facebook/docusaurus★ 67ksame name
- pnpm/pnpm★ 37ksame name
- verdaccio/verdaccio★ 18ksame name
- Effect-TS/effect★ 18ksame name
- coder/coder★ 17ksame name
- microsoft/agent-framework★ 15ksame name
- cloudflare/computer★ 9.9ksame name
- pluk-inc/markdown-preview★ 2.8ksame name
- pluk-inc/md-preview.app★ 2.8ksame name
- Livinglist/Hacki★ 1.6ksame name
5 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- coding-styleSkill
- working-with-configSkill
- writing-build-stepsSkill
- writing-testsSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
23 rules. 0 are common, 13 are distinctive, and 10 are very specific to this project.
0
Common
Most of the 15 edited versions we read keep these.
13
Distinctive
This author's own choices. Worth a look.
10
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
Write a clear, natural-language sentence that describes the change:
- Very specific: line 16
Do not prefix with feat:, fix:, chore:, docs:, refactor:, or any other Conventional Commits type — the Quarkus bot will flag this
- Distinctive: line 18
Keep it concise but descriptive
- Distinctive: line 19
Do not end with a period
- Distinctive: line 33
Keep it concise — a short paragraph is usually enough
- Distinctive: line 34
Do not include a "Test plan" or "Summary" section
- Distinctive: line 35
Do not include "Generated with Claude Code" or similar footers
- Very specific: line 36
Do not include Co-Authored-By trailers referencing an AI tool
- Very specific: line 40
If your PR introduces a noteworthy feature, include a single line at the end of the description prefixed with Release note: that can be …
- Distinctive: line 53
If the change is breaking, explain in the description:
- Very specific: line 60
Every pull request fixes or implements an issue.
- Very specific: line 63
Write a reference as a bare #1234 so GitHub shows its title.
- Distinctive: line 69
Do not open a second pull request with another solution to the same issue.
- Distinctive: line 72
When a pull request needs another one first, say so in the description and link it.
- Distinctive: line 83
Keep the title in sync with the change.
- Distinctive: line 91
Write commit messages as clear, natural-language sentences starting with an uppercase letter — same style as the PR title
- Very specific: line 93
Do not add Co-Authored-By trailers referencing AI tools (e.g.
- Very specific: line 107
Run ./mvnw process-sources on changed modules to fix formatting
- Very specific: line 108
Run tests in Java mode (./mvnw verify -f extensions/<name>/)
- Very specific: line 110
If adding a new integration test module, register it in .github/native-tests.json
- Very specific: line 112
Update documentation in docs/src/main/asciidoc/ when the change affects user-facing behavior, config, or APIs
- Distinctive: line 118
Do not submit code, tests, or descriptions copied directly from an LLM without human review
- Distinctive: line 121
Do not use bots or agents to open PRs without human authorship and responsibility
“Common” is measured: kept by at least 6 in 10 of the 15 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Pull Requests
PR Title
Write a clear, natural-language sentence that describes the change:
- Start with an uppercase letter
- Do not prefix with
feat:,fix:,chore:,docs:,refactor:, or any other Conventional Commits type — the Quarkus bot will flag this - Keep it concise but descriptive
- Do not end with a period
Examples
Add multipart upload support to RESTEasy Reactive
Fix NPE when config property is unset
Update OIDC provider configuration guide
Simplify bean resolution logic in ArCPR Description
- Explain why the change is needed, not what changed (the diff shows that)
- Keep it concise — a short paragraph is usually enough
- Do not include a "Test plan" or "Summary" section
- Do not include "Generated with Claude Code" or similar footers
- Do not include
Co-Authored-Bytrailers referencing an AI tool
Noteworthy features
If your PR introduces a noteworthy feature, include a single line at the end of
the description prefixed with Release note: that can be used verbatim in the
release notes. Keep it user-facing — focus on the benefit, not the implementation:
Release note: RESTEasy Reactive now supports multipart file uploads with
progress tracking via the new `@PartProgress` annotation.Only do this for noteworthy features, not small enhancements or bug fixes
Breaking changes
If the change is breaking, explain in the description:
- What breaks
- Why it was necessary
- How users should migrate
Linked issue
Every pull request fixes or implements an issue. When none exists, open
it first with the matching template. End the description with
Fixes #1234 on its own line. Do not put the issue number in the title.
Write a reference as a bare #1234 so GitHub shows its title.
One concern per pull request
- A pull request fixes one issue or adds one feature. Put an unrelated fix or a clean-up in a separate pull request, even when it is small.
- Do not open a second pull request with another solution to the same issue. Describe the other solutions in the issue or in the description, and let the reviewers choose.
- When a pull request needs another one first, say so in the description and link it.
Updating a pull request after review
- Rebase on
mainand push with--force-with-lease. Never mergemaininto the branch: a merge commit fails the "Merge commits" check. - Answer every review thread after the push. Start with the answer, then link the commit that applies it.
- Change the description when the change changed. A reviewer reads the description first, and a stale one costs a review round.
- Keep the title in sync with the change.
Commits
- Commits must be atomic and semantic — each commit should represent one logical change
- Properly squash fixup commits before the PR is ready for merge. Fixup commits are acceptable during review, but must be squashed at the end
- Write commit messages as clear, natural-language sentences starting with an uppercase letter — same style as the PR title
- Do not add
Co-Authored-Bytrailers referencing AI tools (e.g.Co-Authored-By: Claude,Co-Authored-By: Copilot)
Labels
Apply these labels when relevant:
| Label | When to apply |
release/noteworthy-feature | The PR introduces a significant user-facing feature that should appear in release notes |
release/breaking-change | The PR contains a breaking change (API removal, behavior change, config rename) |
Before Submitting
- Run
./mvnw process-sourceson changed modules to fix formatting - Run tests in Java mode (
./mvnw verify -f extensions/<name>/) - For non-trivial changes, test in native mode (
-Dnative) - If adding a new integration test module, register it in
.github/native-tests.json - Update documentation in
docs/src/main/asciidoc/when the change affects user-facing behavior, config, or APIs
LLM / Agent Policy
- You are responsible for validating every change you submit — AI-assisted or not
- Do not submit code, tests, or descriptions copied directly from an LLM without human review
- AI-generated tests must validate actual behavior, not just exercise code paths
- Do not use bots or agents to open PRs without human authorship and responsibility
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

