docs: add COLLABORATORS.md#4254
Open
reinkrul wants to merge 3 commits into
Open
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
reinkrul
requested review from
gerardsn,
stevenvegt and
woutslakhorst
as code owners
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
Contributor
|
Coverage Impact This PR will not change total coverage. 🚦 See full report on Qlty Cloud »🛟 Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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