agentleFS
Sign inStart free
equinorequinor/neqsim/.github/copilot-instructions.md

neqsim

Copilot instructions167 starsChanged 7 months agoApache-2.0View on GitHub

All agent rules are in AGENTS.md at the repository root. VS Code loads it automatically; if it is not already in your context, read it once. Detail is in docs/development/AGENT_REFERENCE.md (search it; never read it whole). Repeated below for tools that read only this file (e.g. code review): - Java 8 only, tests included: no var, List.of/Set.of/Map.of, String.repeat (use StringUtils.repeat), isBlank/strip/lines, text blocks, records, pattern-matching instanceof, Optional.isEmpty(). - Logging: Log4j2 logger with parameterized calls; never System.out/err.println. - Formatting: run mvnw…

The file

We split this copilot-instructions.md into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    All agent rules are in AGENTS.md at the repository root.

    line 3
  2. Very specific:

    Formatting: run mvnw spotless:apply after editing any .java file.

    line 12
  3. Very specific:

    After a flash, call fluid.initProperties() before reading transport properties.

    line 17

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “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
copilot-instructions.md

NeqSim — Copilot Instructions

All agent rules are in AGENTS.md at the repository root. VS Code loads it automatically; if it is not already in your context, read it once. Detail is in docs/development/AGENT_REFERENCE.md (search it; never read it whole). Repeated below for tools that read only this file (e.g. code review):

  • Java 8 only, tests included: no var, List.of/Set.of/Map.of, String.repeat (use StringUtils.repeat), isBlank/strip/lines, text blocks, records, pattern-matching instanceof, Optional.isEmpty().
  • Logging: Log4j2 logger with parameterized calls; never System.out/err.println.
  • Formatting: run mvnw spotless:apply after editing any .java file; CI runs spotless:check.
  • JavaDoc on every class and method (private too): @param, @return, @throws; HTML5 tables need <caption>; @see only with Java references; no orphan </p> after lists.
  • Serializable classes: non-serializable fields must be transient.
  • Verify constructor and method signatures before using an API; doc snippets need a passing test.
  • After a flash, call fluid.initProperties() before reading transport properties; always set a mixing rule.
  • Every flow diagram (PFD/BFD/P&ID sketch) must pass pfd-layout-review (neqsim pfd-check) before it is used.

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.

Check your setup, free