Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (31 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

38 lines (31 loc) · 1.93 KB
Raw

Contributing

abcd is a private incubation repo for now; it flips public at maturity. See AGENTS.md for build/test/checks and working conventions, and .abcd/development/ for the design record.

  • Branch + PR for substantive changes; CI (build/vet/test on macOS + Linux, gitleaks, zizmor) gates the merge. make preflight runs the same checks locally via the pre-push hook.
  • Conventional-commit prefixes (feat/fix/docs/chore/refactor/test/ci), no scopes; short title, body explains why.
  • A CHANGELOG entry accompanies any user-facing change.
  • Docs are Diátaxis (one type per page, present tense); the design record lives under .abcd/, never in docs/.

AI assistance and authorship

Development of abcd is assisted by an AI coding assistant. Two rules keep that honest:

  • Human author of record. The human contributor is the author of every change they submit and is responsible for all AI-assisted output — its correctness, its licensing, and its fit for the project. AI assistance never transfers that responsibility.
  • Disclosure by trailer, not co-authorship. AI-assisted commits carry an Assisted-by: Claude:<model-version> trailer (the Linux kernel format) — disclosure only. abcd never uses Co-Authored-By: for AI: it asserts an authorship the tool does not hold and inflates the contributor graph. A human-only Signed-off-by: (DCO) is deferred until the repo is public or takes its first outside contribution.

Acknowledgements

ACKNOWLEDGEMENTS.md credits the ideas, tools, and writing behind abcd in three parts — development, inspirations, and references. Add an entry in the same change that lands it: the PR that adopts an external pattern, cites a source in an ADR, or integrates a tool. Adding it at the moment it lands is what keeps the file from going stale — it is never reconstructed after the fact.