SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillssetup-conventions

setup-conventions

Deployment & operations

View repository

Updated 10-15 19:56

About this skill

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

Need Skill
The tickets the tracker file enables cut-tickets
The records the conventions file points at decision-records
Landing the setup pull request thin-slices