Skip to content

docs: rewrite the contributor guide around repo-specific rules - #386

Merged
cplieger merged 1 commit into
mainfrom
docs/contributor-guide
Oct 5, 2026
Merged

cplieger merged 1 commit into
mainfrom
docs/contributor-guide

Conversation

@cplieger

@cplieger cplieger commented Oct 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrites CONTRIBUTING.md to hold only what is specific to this repository. Commits, releases, synced files, checks, review and scope come from the shared contributing rules, which this guide now links instead of restating.
  • Every rule that stays names what breaks when a contributor ignores it.
  • Points the README's Contributing section at the guide.

Testing

  • Two independent reviews checked each kept statement against the code and checked that nothing a contributor needs was dropped. A final check reran the claim checks after the fixes.
  • A blind contributor read planned three typical changes using only the guide and the code, and reported anything the guide failed to tell it.
  • markdownlint, link checks and the docs scanner pass.

@cplieger
cplieger merged commit 5902009 into main Oct 5, 2026
19 checks passed
@cplieger
cplieger deleted the docs/contributor-guide branch October 5, 2026 08:05
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.

1 participant