coding-style
Skill325 starsChanged 7 days agoApache-2.0View on GitHub
Quarkus code style conventions: formatting, visibility, naming, logging, and general style rules for the Quarkus codebase.
14 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
- TsukiNi22/skillstheir own version, first seen Nov 16, 2026
- TsukiNi22/ai-utilstheir own version, first seen Nov 16, 2026
- static-web-server/static-web-servertheir own version, first seen Nov 9, 2026
- thunderstormwang/AgentSkillstheir own version, first seen Nov 6, 2026
- els0r/skillstheir own version, first seen Oct 13, 2026
- AltraMayor/f3their own version, first seen Oct 8, 2026
Used with
Projects with it also use git-commit.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
MicrosoftSkillgit-commit
Stage user-selected paths, confirm the exact staged set, and create one local Conventional Commit, or generate a commit message for staged changes without committing. Use when you want a guarded commit or a ready-to-paste message.
Also in 3 projects that use this
Other versions14 projects use a version of this.
Word for word · 1
- quarkusio/quarkus★ 16k100% same
Edited · 0
None found.
Wrote their own version · 13
- AltraMayor/f3★ 3.4ksame name
- static-web-server/static-web-server★ 2.4ksame name
- codetesla51/skills★ 32same name
- Fuwn/suckless-agent-skills★ 18same name
- RichieHakim/agent_skills★ 5same name
- 26zl/universal-agent-skills★ 3same name
- els0r/skills★ 1same name
- loboking/gemini-skills★ 1same name
- matejformanek/postgres-claude★ 1same name
- TsukiNi22/ai-utils★ 1same name
3 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
- pull-requestsSkill
- 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
18 rules. 0 are common, 9 are distinctive, and 9 are very specific to this project.
0
Common
Most of the 13 edited versions we read keep these.
9
Distinctive
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Very specific: line 16
Run ./mvnw process-sources on your module to auto-format before committing
- Distinctive: line 22
Prefer package-private (default) visibility for internal implementation classes
- Very specific: line 23
Use public for user-facing API and for classes/methods that need to be accessed across packages (e.g., processors, build items).
- Very specific: line 26
Use protected when designing for extension/subclassing
- Very specific: line 42
Never use fully-qualified class names inline — always add an import statement instead
- Very specific: line 43
Avoid static imports except for well-known patterns (e.g., test assertions)
- Distinctive: line 45
Prefer descriptive method and variable names over comments
- Distinctive: line 46
Update existing code comments if your changes make them invalid
- Distinctive: line 47
Never remove existing code comments that are still valid
- Distinctive: line 48
Keep methods focused and short.
- Very specific: line 49
Use Optional for API return types that may be absent.
- Distinctive: line 53
Don't use deprecated methods or classes in new code
- Very specific: line 71
Use JBoss Logging (org.jboss.logging.Logger) as the logging API
- Very specific: line 72
Do NOT use System.out.println or System.err.println
- Distinctive: line 73
Do NOT use SLF4J, java.util.logging, or Log4j directly in Quarkus core/extension code
- Very specific: line 80
Start with an action verb, unconjugated (Connect foo, not Connects foo)
- Distinctive: line 81
Not mention "Quarkus" or "extension"
- Distinctive: line 82
Not repeat the extension name
“Common” is measured: kept by at least 6 in 10 of the 13 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
Coding Style
Formatting
- Quarkus uses 4-space indentation (no tabs)
- The project enforces formatting via
formatter-maven-pluginandimpsort-maven-plugin, let the formatting plugins do their work, never use-Dno-format - Formatter config:
independent-projects/ide-config/src/main/resources/eclipse-format.xml - Run
./mvnw process-sourceson your module to auto-format before committing - The build will fail on formatting violations
- Imports are sorted and organized automatically; do not manually organize imports
Visibility
- Prefer package-private (default) visibility for internal implementation classes
- Use
publicfor user-facing API and for classes/methods that need to be accessed across packages (e.g., processors, build items). Prefer package-private for purely internal implementation details - Use
protectedwhen designing for extension/subclassing - Internal classes should go in
.internalor.implsub-packages (e.g.,io.quarkus.<ext>.runtime.internal)
Naming
- Deployment processors:
<Feature>Processor.java - Build items:
<Description>BuildItem.java - Config interfaces:
<Feature>Config.javaor<Feature>BuildTimeConfig.java/<Feature>RuntimeConfig.java - Artifact IDs:
quarkus-<name>(runtime),quarkus-<name>-deployment(deployment) - Package root:
io.quarkus.<extension-name>(hyphens become underscores)
General Style
- No
@authortags in Javadoc — Git history tracks authorship - No wildcard imports
- Never use fully-qualified class names inline — always add an
importstatement instead - Avoid
staticimports except for well-known patterns (e.g., test assertions) - Minimize lambdas and streams in runtime code — reduces memory footprint for native
- Prefer descriptive method and variable names over comments
- Update existing code comments if your changes make them invalid
- Never remove existing code comments that are still valid
- Keep methods focused and short; extract when complexity warrants it
- Use
Optionalfor API return types that may be absent. In internal hot runtime code paths, direct null checks are acceptable for performance - Commits should be atomic and semantic — properly squash before submitting PRs. This helps during bisects and makes it easier to revert changes when needed
- Don't use deprecated methods or classes in new code
Bytecode
- Generate bytecode with Gizmo 2 (
io.quarkus.gizmo2), writing the classes throughGeneratedClassGizmo2Adaptor. Gizmo 1 (io.quarkus.gizmo) is legacy; do not add new Gizmo 1 code. - Read and inspect bytecode with the ClassFile API backport
(
io.smallrye.classfile, artifactio.smallrye.classfile:jdk-classfile-backport, the same API asjava.lang.classfile):ClassFile.of().parse(bytes), thenmethods(),code(),elementList(). This applies to tests that check generated classes too. - Never add ASM (
org.objectweb.asm) to new code or tests. The only remaining ASM entry point isBytecodeTransformerBuildItem, whose transformers still take an ASMClassVisitor; keep those minimal.
Logging
- Use JBoss Logging (
org.jboss.logging.Logger) as the logging API - Do NOT use
System.out.printlnorSystem.err.println - Do NOT use SLF4J, java.util.logging, or Log4j directly in Quarkus core/extension code
Extension Descriptions
Extension descriptions (in runtime/pom.xml or quarkus-extension.yaml) should:
- Be short (no hover required)
- Describe the function, not the technology
- Start with an action verb, unconjugated (
Connect foo, notConnects foo) - Not mention "Quarkus" or "extension"
- Not repeat the extension name
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.

