agentleFS
Sign inStart free
hyperledger-labshyperledger-labs/splice/.claude/skills/project-conventions/SKILL.md

project-conventions

Skill122 starsChanged 18 days agoApache-2.0View on GitHub

Repo-wide coding conventions enforced by pre-commit (copyright headers, scalafmt, Daml warts, TS formatting) so generated code matches on the first pass.

17 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use e2e-template-testing, notification-routing and 9 more.

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

    e2e-template-testing

    End-to-end validation of coordinator and agent template changes

    Also in 3 projects that use this

  • GitHubSkill

    notification-routing

    Route agent notifications to specific channels by type — prevent alert fatigue from single-channel flooding

    Also in 3 projects that use this

  • Microsoft AzureSkill

    coordinator-source-of-truth

    The complete file-by-file source-of-truth hierarchy for Squad: which files are authoritative, which are derived/append-only, who may write each one, who may read each one, and the precedence rules when they conflict. Squad coordinator loads this on demand when it needs to resolve a write conflict, decide where a piece of state belongs, or answer a 'who owns this file' question.

    Also in 3 projects that use this

  • Microsoft AzureSkill

    cross-squad-communication

    Protocol for sending queries, delegating tasks, and sharing context between independent Squad instances across different repositories

    Also in 3 projects that use this

  • SentrySkill

    skill-creator

    Create new agent skills following the Agent Skills specification. Use when asked to "create a skill", "add a new skill", "write a skill", "make a skill", "build a skill", or scaffold a new skill with SKILL.md. Guides through requirements, writing, registration, and verification.

    Also in 3 projects that use this

  • +4 more from github
  • +2 more from Azure
  • Other versions17 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 17

    1. github/gh-aw★ 5.6ksame name
    2. github/squad★ 3.4ksame name
    3. Soju06/codex-lb★ 3.3ksame name
    4. nextcloud/notes-android★ 1.1ksame name
    5. TangleML/tangle-ui★ 104same name
    6. Azure/apiops-cli★ 32same name
    7. choi138/toki★ 9same name
    8. frnkgns/Overgeared-Skills★ 7same name
    9. batin/five-guys★ 2same name
    10. g-cqd/skills★ 2same name

    7 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 repository4 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 11 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

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

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

    Every source file (.daml, .scala, .sh, .py, .tsx, .rst) needs the SPDX copyright header (see scripts/rename.sh, headerCreate sbt task).

    line 12
  2. Very specific:

    No trailing whitespace (check-trailing-whitespace.sh).

    line 13
  3. Very specific:

    Follow .scalafix.conf rules where applicable.

    line 17
  4. Very specific:

    After adding, deleting or renaming a test suite under /test//*.scala, run sbt updateTestConfigForParallelRuns and commit the test*.log …

    line 18
  5. Very specific:

    No illegal cross-package Daml references (scripts/rename.sh no_illegal_daml_references) — don't import across module boundaries that aren't …

    line 21
  6. Very specific:

    Avoid Daml warts flagged by scripts/check-daml-warts.sh (e.g.

    line 22
  7. Very specific:

    All Daml return types must satisfy scripts/check-daml-return-types.sh — avoid inferred/implicit return types where the script expects …

    line 23

“Common” is measured: kept by at least 6 in 10 of the 11 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

splice project conventions

These are enforced by .pre-commit-config.yaml and CI; matching them up front avoids pre-commit failures and review churn.

All languages

  • Every source file (.daml, .scala, .sh, .py, .tsx, .rst) needs the SPDX copyright header (see scripts/rename.sh, headerCreate sbt task). Copy the header from a neighboring file in the same directory rather than inventing one.
  • No trailing whitespace (check-trailing-whitespace.sh).

Scala

  • Format with scalafmt rules in .scalafmt.conf; don't hand-format against them.
  • Follow .scalafix.conf rules where applicable.
  • After adding, deleting or renaming a test suite under **/test/**/*.scala, run sbt updateTestConfigForParallelRuns and commit the test*.log files it changes. Static checks regenerate them and fail on any diff (build.static_tests.yml, "Verify no changes in SBT test files").

Daml

  • No illegal cross-package Daml references (scripts/rename.sh no_illegal_daml_references) — don't import across module boundaries that aren't part of the public API.
  • Avoid Daml warts flagged by scripts/check-daml-warts.sh (e.g. unsafe patterns the repo has banned).
  • All Daml return types must satisfy scripts/check-daml-return-types.sh — avoid inferred/implicit return types where the script expects explicit ones.
  • Changing daml.yaml or .daml files requires the dars_lock file to stay in sync (damlDarsLockFileUpdate).
  • Frontend packages import generated JS bindings such as @daml.js/splice-wallet. These are not npm dependencies: apps/generated-packages.json maps each alias to its generated directory (e.g. splice-wallet-0.1.23) and apps/scripts/link-generated-packages.mjs links them into node_modules on npm install. Bumping a Daml package version means regenerating and updating that mapping (sbt damlBumpPackageVersions does it); check it for stale versions after Daml model changes.

TypeScript / frontend

  • Format via scripts/fix-ts.py, not raw prettier — it wraps prettier with repo-specific behavior. Skip *.prettierrc.cjs files.
  • Each frontend app (ans, scan, splitwell, sv, validator, wallet) under apps/ has its own openapi-ts-client package generated from the app's OpenAPI spec — don't hand-edit generated client code; regenerate instead.
  • ESLint runs with --max-warnings=0 — warnings fail the build, not just errors.
  • Workspaces are declared in apps/package.json; new frontend packages must be added there.

Shell / CI / infra

  • Shellcheck applies to all *.sh except under canton/ and .envrc (-e SC1091 globally ignored).
  • Changes under .github/** and gha-scripts/actions/** are checked by scripts/actionlint.sh and scripts/zizmor.sh.
  • Changes to cluster/pulumi/**/*.ts or any cluster/**/*.{yaml,yml} trigger make cluster/pulumi/test — verify Pulumi tests pass locally before proposing infra changes.
  • Grafana dashboard JSON under cluster/pulumi/observability/grafana-dashboards/ is validated by scripts/check-grafana-dashboards.sh.

AI-assisted contributions

Per AI_POLICY.md: the human author is fully accountable for AI-assisted contributions and must be able to explain every line. Don't pad PRs or review comments with unreviewed AI output — self-review before handing anything to a human reviewer.

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