Home / equinor / neqsim · .github/skills/neqsim-code-hygiene/SKILL.md · GitHub

neqsim-code-hygiene skillA

neqsim-code-hygiene is agent-read markdown (skill) from equinor/neqsim: Fix formatting, Checkstyle, Spotless, and JavaDoc build failures in NeqSim Java code. USE WHEN: the build fails on spotless:check, checkstyle:check, or javadoc:javadoc; a PR shows formatting/import-order/JavaDoc violations; or you edited any .java file and need to make it CI-clean. Covers the exact recurring errors (JavadocParagraph <p>, orphan </p> after lists, single-line @param/@return, import ordering, HTML5 tables, unused variables) and the fix-and-verify loop..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# NeqSim Code Hygiene: Formatting, Checkstyle, Spotless & JavaDoc Fixes

This skill is the fix-it playbook for the code-quality gates that fail NeqSim CI:
`spotless:check` (formatting), `checkstyle:check` (style, imports, JavaDoc structure),
and `javadoc:javadoc` (HTML5-valid JavaDoc). It maps each recurring error message to
its exact cause and fix, and gives the mandatory verify loop. For the separate rule
set on which Java **language features** are allowed, load `neqsim-java8-rules`.

## When to Use This Skill

- The build fails on `spotless:check`, `checkstyle:check`, or `javadoc:javadoc`.
- A PR or the Problems panel shows formatting, import-order, or JavaDoc violations.
- You created or edited ANY `.java` file (main, test, or examples) and must make it CI-clean.
- You pasted a JavaDoc/error block and asked "fix errors like this".

## The Fix-and-Verify Loop (do this every time)

1. **Format first** — Spotless fixes whitespace/indentation but NOT import order or JavaDoc content:
   ```bash
   ./mvnw spotless:apply
   ```
2. **Fix Checkstyle/JavaDoc by hand** — imports, `<p>` tags, single-line JavaDoc, tables (below).
…

Read the whole file at its exact version.

How to install

Latest version
mdr add equinor/neqsim/neqsim-code-hygiene@v1.0.0
Exact content
mdr add equinor/neqsim/neqsim-code-hygiene@sha256:8ca0467254295624

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_x6umfojqb4ixnhsa.svg)](https://markdownregistry.com/a/art_x6umfojqb4ixnhsa)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
v1.0.0 latest2026-09-18 c6f8628 10,784 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (10784 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

equinor/neqsim · 155 stars · license Apache-2.0 · pushed 2026-09-24 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_x6umfojqb4ixnhsa
GET https://markdownregistry.com/api/v1/resolve?ref=equinor/neqsim/neqsim-code-hygiene
GET https://markdownregistry.com/api/v1/blob/8ca04672542956244bab19dcaafb2ef604ec8ed58da28c9ca307f879b0749c0b

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from equinor/neqsim

.cursorrules rules
equinor/neqsim · .cursorrules
git:20260418.119a3f4 · audit A · 155 stars
analyze-convergence skill
equinor/neqsim · .github/skills/analyze-convergence/SKILL.md · Interpret flash algorithm convergence metrics, identify patterns, and produce
git:20260919.77c34a0 · audit A · 155 stars
analyze-gibbs-convergence skill
equinor/neqsim · .github/skills/analyze-gibbs-convergence/SKILL.md · Interpret Gibbs energy minimization convergence metrics, analyze Jacobian
git:20260919.77c34a0 · audit A · 155 stars
book-creation skill
equinor/neqsim · .github/skills/book-creation/SKILL.md · PaperLab skill for book creation workflows in scientific writing and book production.
git:20260919.77c34a0 · audit B · 155 stars
design-flash-benchmark skill
equinor/neqsim · .github/skills/design-flash-benchmark/SKILL.md · Create a structured test matrix for comparing flash algorithm performance
git:20260919.77c34a0 · audit A · 155 stars
design-reactor-benchmark skill
equinor/neqsim · .github/skills/design-reactor-benchmark/SKILL.md · Create a structured test matrix for evaluating Gibbs energy minimization
git:20260919.77c34a0 · audit A · 155 stars
figure-discussion skill
equinor/neqsim · .github/skills/figure-discussion/SKILL.md · PaperLab skill for figure discussion workflows in scientific writing and book production.
git:20260919.77c34a0 · audit A · 155 stars
generate-publication-figures skill
equinor/neqsim · .github/skills/generate-publication-figures/SKILL.md · Create matplotlib figures that meet journal submission standards: correct fonts,
git:20260919.77c34a0 · audit A · 155 stars
journal-formatting skill
equinor/neqsim · .github/skills/journal-formatting/SKILL.md · Apply journal-specific formatting rules to transform a manuscript from Markdown
git:20260919.77c34a0 · audit A · 155 stars
neqsim-agent-handoff skill
equinor/neqsim · .github/skills/neqsim-agent-handoff/SKILL.md · Agent-to-agent communication schema for NeqSim. USE WHEN: composing multi-agent pipelines where one agent's output…
git:20260919.77c34a0 · audit A · 155 stars
neqsim-agentic-process-optimization skill
equinor/neqsim · .github/skills/neqsim-agentic-process-optimization/SKILL.md · Agentic, closed-loop optimization of large multi-area NeqSim ProcessModel plants using the newest automation…
v1.0.0 · audit A · 155 stars
neqsim-api-patterns skill
equinor/neqsim · .github/skills/neqsim-api-patterns/SKILL.md · NeqSim API patterns and code recipes. USE WHEN: writing Java or Python code that uses NeqSim for thermodynamic…
git:20260920.f008895 · audit A · 155 stars

Every file in equinor/neqsim

Browse by kind, by grade A, or by owner.