agentleFS
anivaranivar/agentic-sdlc/skills/setup-conventions/SKILL.md

setup-conventions

Skill0 starsChanged 37 days agoMITView on GitHub

One-time repository setup for the agentic-sdlc skills: explore what the repository already has, confirm the choices with the decider, then write one "Rules that bind" block into the existing AGENTS.md or CLAUDE.md, docs/agents/tracker.md and docs/agents/conventions.md, and .agentic-sdlc.json with the hook settings, and prepare the forge's check (the reusable workflow and the ruleset on GitHub, the CI job on GitLab) as a pull request. Run once per repository, by the person who owns it.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 1

    1. iammrduncan/skills★ 4same name

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

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read what exists; assume nothing (EVID-8):

    line 30
  2. Very specific:

    If the tracker is local markdown: .scratch/ in .gitignore.

    line 66
  3. Distinctive:

    All of it lands as one reviewed pull request (SETUP-3).

    line 72

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill 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
SKILL.md

Set up conventions

A prompt-driven setup, not a script. Explore, present what was found, confirm, then write. Nothing is committed, pushed or imported without its own go-ahead (ASK-1, ASK-2, ASK-3).

1. Explore

Read what exists; assume nothing (EVID-8):

  • git remote -v: which forge, which repository.
  • AGENTS.md and CLAUDE.md at the root: which exists, whether a "Rules that bind" block is already there.
  • docs/agents/, .agentic-sdlc.json, GLOSSARY.md, docs/adr/, .scratch/.
  • .github/workflows/: an existing CI gate the ruleset should require.
  • Rulesets and branch protection already applied (gh ruleset list on GitHub; the protected branches of the project on GitLab).
  • Monorepo signals: a workspace file, several packages with their own source.

2. Present and confirm

Lead each section with the recommended answer so the decider can accept it in a word.

  • Tracker: GitHub issues when the remote is GitHub; GitLab when it is GitLab; local markdown under .scratch/ for a repository without a remote; "other" recorded as a paragraph. Labels default to needs-triage, needs-info, ready-for-agent, ready-for-human, wontfix.
  • Protected branches: main plus any release branch.
  • Attribution mode: patterns (the default) or strict.
  • Decision records: docs/adr/ in the repository, or a private path the repository's docs/agents/conventions.md names.
  • Mechanisms: the reusable workflow as a required check, and the ruleset import.

3. Write

In this order, each shown before it is written and each path checked first (DECIDE-5):

  1. The "Rules that bind" block into the file that exists, in place if a block is already there (SETUP-1). Template: assets/AGENTS-block.md beside this skill. Never create a second agent file beside the existing one; when neither AGENTS.md nor CLAUDE.md exists, ask which one to create and never pick.
  2. docs/agents/tracker.md (SETUP-2) from assets/docs-agents/tracker.md.
  3. docs/agents/conventions.md from assets/docs-agents/conventions.md.
  4. .agentic-sdlc.json from assets/agentic-sdlc.json, with the confirmed branches and mode. agentic-sdlc validate passes on it.
  5. If the tracker is local markdown: .scratch/ in .gitignore.
  6. On GitHub: a workflow file that calls anivar/agentic-sdlc/.github/workflows/conventions.yml at a pinned tag, and the import command for rulesets/main-protected.json with the required check names adjusted to this repository's gate. On GitLab: the job from assets/gitlab-ci.yml in .gitlab-ci.yml. Elsewhere: the native git hooks (agentic-sdlc hooks install).

All of it lands as one reviewed pull request (SETUP-3). The ruleset import is run by the decider after the merge, since it changes the forge's settings.

4. Done

Say which skills now read from these files, and that re-running the setup is only needed to switch trackers or change the mode. Editing docs/agents/*.md and .agentic-sdlc.json by hand is the normal path afterwards. An edit to .agentic-sdlc.json, a git hook, .claude/settings.json or .pre-commit-config.yaml changes what the guard does, so it is described and agreed before it is written (GUARD-2).

Companion skills

NeedSkill
The tickets the tracker file enablescut-tickets
The records the conventions file points atdecision-records
Landing the setup pull requestthin-slices

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.