Skip to content

David-BS/method-kit

Repository files navigation

method-kit

A versioned, transverse meta-methodology for piloting software projects with an AI assistant. method-kit captures — as loadable files and packaged skills — a way of working (session discipline, engineering rigour, CI/CD posture, assistant/operator exchange) so it travels from one project to the next instead of being re-taught every time or lost between conversations.


What this is

method-kit carries a method, not the state of any one application. It ships:

  • method/METHOD.md, the operating method, versioned vX.Y (French — private piloting).
  • the project-pilot suite (skills/project-pilot/) — one installable container that bundles the procedural tools as modules (steering-doc editing, diagram generation, command linting, projected-doc drift checking, skill packaging, the remontée runbook, filename stamping) plus its resources: the steering-doc templates (ROADMAP / JOURNAL / GLOSSAIRE) and PROJECT_INIT.md, the bootstrap runbook. One suite, one version. A deterministic test floor guards each checker — 18 in all, auto-discovered by # FLOOR markers.

The one design fact that shapes everything: what must survive travels as a file or a skill, never as chat history — assistant memory is per-project and lossy, a loaded file is verbatim.

Scope & compatibility

  • Consumed inside Claude: the project-pilot suite is installed at the account level (its templates and PROJECT_INIT.md travel inside it, as resources); only METHOD.md and the project's own steering-doc instances are loaded into a Claude Project's knowledge.
  • The tooling targets Python 3.12; the command discipline assumes Git Bash on Windows.
  • This is not a published Python package — pyproject.toml carries only [tool.*] configuration, with no build/[project] section.
  • The piloting docs (method/, pilotage/) are in French (private piloting); the repository's engineering layer (this README, CONTRIBUTING.md, CI_CD.md, ARCHITECTURE.md, the workflows) is in English.

Download & install

Requirements: a Claude account with skills enabled. No local setup is required to use the kit; Python 3.12 + Git Bash are only needed to develop it (see CONTRIBUTING.md).

There is no downloadable release asset today — method-kit is adopted, not installed from a binary:

  1. Install the project-pilot suite (skills/project-pilot/) at your Claude account level — it carries its modules and its resources (templates + PROJECT_INIT.md), so they travel across all your projects with it.
  2. Load docs/METHOD.md into a Claude Project's knowledge (the templates and bootstrap runbook now come with the suite — you no longer load them separately).
  3. Start a session — the assistant reads METHOD.md, then the project ROADMAP (§6 ÉTAT), and follows them.

Data discipline

  • This repository ships fictional placeholder data only.
  • Real project state lives in that project's own roadmap/journal — never in this kit.
  • The .gitignore blocks the piloting-doc and personal-data patterns as a safety net.

Repository layout

.
├── method/                 ← METHOD.md — the method (FR, private piloting)
├── pilotage/               ← frozen copy of this project's steering docs (FR, private)
├── skills/                 ← the project-pilot suite (modules + resources: templates, PROJECT_INIT)
├── scripts/                ← repository scripts (e.g. Layer-B setup)
├── pyproject.toml          ← single source for the toolchain config (no build section)
├── .github/workflows/      ← CI gates (quality · tests · security · Analyze) + action-drift watch; release on v*
├── README.md  CONTRIBUTING.md  CI_CD.md  ARCHITECTURE.md   ← this doc · contributor guide · CI/CD deep-dive · code-layout map
└── .gitattributes  .gitignore

Build & release (for maintainers)

The suite is packaged as one versioned .skill archive; the version is read from skills/project-pilot/SKILL.md metadata.version, never hand-passed (the skill-packaging skill produces project-pilot_vX.Y.Z_YYYY-MM-DD.skill).

The v*-tag release path (release.yml) is wired: on a tag push it packages the versioned .skill (package_skill.py reads the version from SKILL.md metadata.version, never typed), guards that the pushed tag matches the artifact's version, and attaches the archive to a GitHub Release. A fictional-data acceptance gallery is not part of the release yet — that remains future work.

git tag <vX.Y.Z>;
git push origin <vX.Y.Z>

License

This is a private project. It is not yet licensed for redistribution.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors