Skip to content

docs: add COLLABORATORS.md#4254

Merged
reinkrul merged 4 commits into
masterfrom
docs/collaborators-guide
May 24, 2026
Merged

docs: add COLLABORATORS.md#4254
reinkrul merged 4 commits into
masterfrom
docs/collaborators-guide

Conversation

@reinkrul

@reinkrul reinkrul commented May 18, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds COLLABORATORS.md describing how to contribute: when to open an issue first, keep PRs small, signed commits, Conventional Commits, matching surrounding code conventions, tests, codegen via the makefile, and review etiquette (no force-push after review starts).
  • Points the existing contribution touchpoints at the new file instead of duplicating content:
    • 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

  • Render COLLABORATORS.md on GitHub and check links resolve.
  • Render docs/pages/contribute.rst on Read the Docs and check the link resolves.

Assisted by AI

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
reinkrul added 2 commits May 18, 2026 11:29
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
@qltysh

qltysh Bot commented May 18, 2026

Copy link
Copy Markdown
Contributor

Qlty


Coverage Impact

⬇️ Merging this pull request will decrease total coverage on master by 0.01%.

🚦 See full report on Qlty Cloud »

🛟 Help
  • Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.

  • Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.

  • File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)

    • Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

@stevenvegt stevenvegt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also add that we cannot accept breaking changes. api, config, behavior etc.

@stevenvegt

Copy link
Copy Markdown
Member

Is this also the place to add the LLM/AI policies?

@reinkrul

Copy link
Copy Markdown
Member Author

also add that we cannot accept breaking changes. api, config, behavior etc.

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.

@stevenvegt

Copy link
Copy Markdown
Member

I think we'll be repeating things that are already covered in other places.
If that is the case, can we link to that?

@reinkrul

Copy link
Copy Markdown
Member Author

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:

@reinkrul
reinkrul merged commit dd9e95d into master May 24, 2026
11 of 12 checks passed
@reinkrul
reinkrul deleted the docs/collaborators-guide branch May 24, 2026 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants