agentleFS
quarkiversequarkiverse/quarkus-langchain4j/.agents/skills/coding-style/SKILL.md

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

Week of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projectsWeek of Oct 25: 0 new projectsWeek of Nov 1: 0 new projectsWeek of Nov 8: 1 new project
Sep 2026Oct 2026Nov 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 1 in all, so this is a hint, not a trend.

Most recently taken up by

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.
  • MicrosoftSkill

    git-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

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
  1. Very specific:

    Run ./mvnw process-sources on your module to auto-format before committing

    line 16
  2. Distinctive:

    Prefer package-private (default) visibility for internal implementation classes

    line 22
  3. Very specific:

    Use public for user-facing API and for classes/methods that need to be accessed across packages (e.g., processors, build items).

    line 23
  4. Very specific:

    Use protected when designing for extension/subclassing

    line 26
  5. Very specific:

    Never use fully-qualified class names inline — always add an import statement instead

    line 42
  6. Very specific:

    Avoid static imports except for well-known patterns (e.g., test assertions)

    line 43
  7. Distinctive:

    Prefer descriptive method and variable names over comments

    line 45
  8. Distinctive:

    Update existing code comments if your changes make them invalid

    line 46
  9. Distinctive:

    Never remove existing code comments that are still valid

    line 47
  10. Distinctive:

    Keep methods focused and short.

    line 48
  11. Very specific:

    Use Optional for API return types that may be absent.

    line 49
  12. Distinctive:

    Don't use deprecated methods or classes in new code

    line 53
  13. Very specific:

    Use JBoss Logging (org.jboss.logging.Logger) as the logging API

    line 71
  14. Very specific:

    Do NOT use System.out.println or System.err.println

    line 72
  15. Distinctive:

    Do NOT use SLF4J, java.util.logging, or Log4j directly in Quarkus core/extension code

    line 73
  16. Very specific:

    Start with an action verb, unconjugated (Connect foo, not Connects foo)

    line 80
  17. Distinctive:

    Not mention "Quarkus" or "extension"

    line 81
  18. Distinctive:

    Not repeat the extension name

    line 82

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Coding Style

Formatting

  • Quarkus uses 4-space indentation (no tabs)
  • The project enforces formatting via formatter-maven-plugin and impsort-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-sources on 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 public for 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 protected when designing for extension/subclassing
  • Internal classes should go in .internal or .impl sub-packages (e.g., io.quarkus.<ext>.runtime.internal)

Naming

  • Deployment processors: <Feature>Processor.java
  • Build items: <Description>BuildItem.java
  • Config interfaces: <Feature>Config.java or <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 @author tags in Javadoc — Git history tracks authorship
  • No wildcard imports
  • Never use fully-qualified class names inline — always add an import statement instead
  • Avoid static imports 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 Optional for 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 through GeneratedClassGizmo2Adaptor. 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, artifact io.smallrye.classfile:jdk-classfile-backport, the same API as java.lang.classfile): ClassFile.of().parse(bytes), then methods(), 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 is BytecodeTransformerBuildItem, whose transformers still take an ASM ClassVisitor; keep those minimal.

Logging

  • Use JBoss Logging (org.jboss.logging.Logger) as the logging API
  • Do NOT use System.out.println or System.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, not Connects foo)
  • Not mention "Quarkus" or "extension"
  • Not repeat the extension name

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.