docs: add COLLABORATORS.md#4254
Conversation
Covers small PRs, signed commits, Conventional Commits, code conventions, tests, code generation via makefile, and review etiquette (no force-push after review starts). Assisted by AI
Avoid duplicating contribution guidance across README.rst, .github/README.md, and docs/pages/contribute.rst — each now links to COLLABORATORS.md. Assisted by AI
README.rst is generated by 'rst_include include README_template.rst README.rst' (via 'make cli-docs'). Update the template so the generated file stays in sync with manual edits. Assisted by AI
|
Coverage Impact ⬇️ Merging this pull request will decrease total coverage on 🛟 Help
|
stevenvegt
left a comment
There was a problem hiding this comment.
also add that we cannot accept breaking changes. api, config, behavior etc.
|
Is this also the place to add the LLM/AI policies? |
I think we'll be repeating things that are already covered in other places. If we want to document workings of specific parts (we're using Koanf) other than what is already documented (env variables, cli flags, etc), I'd rather do that in markdown files next to the code, otherwise this is going to be another very big doc that's going to be out-of-date soon. |
|
Assisted by AI
|
Added a "Backwards compatibility" section that states we don't accept breaking changes to public interfaces (APIs, config, behaviour, network protocols) and links to the existing docs rather than restating them:
|

Summary
COLLABORATORS.mddescribing how to contribute: when to open an issue first, keep PRs small, signed commits, Conventional Commits, matching surrounding code conventions, tests, codegen via themakefile, and review etiquette (no force-push after review starts).README.rst— adds a "Contributing" section linking to it..github/README.md— adds a bullet in "For Contributors".docs/pages/contribute.rst— slimmed to a pointer (was a one-liner already).Test plan
COLLABORATORS.mdon GitHub and check links resolve.docs/pages/contribute.rston Read the Docs and check the link resolves.Assisted by AI