From fe08a77a80f613f8bfbc146ee7236deefa195033 Mon Sep 17 00:00:00 2001 From: shindevlin Date: Mon, 18 May 2026 08:08:54 -0600 Subject: [PATCH] docs: add contributing guide (#3) Co-authored-by: Grouchly --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4278ff4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +Thanks for helping improve this repository. + +## Setup + +1. Fork the repository on GitHub. +2. Clone your fork locally. +3. Create a branch for your change. +4. Make the smallest possible update that solves the issue. + +## Pull request guidelines + +- Keep each pull request focused on one change. +- Reference the issue or bounty in the PR description. +- Describe what changed and why it is correct. +- Include screenshots or other proof only if they help verify the change. + +## Code style + +- Match the existing tone and formatting of the repository. +- Prefer small, readable edits. +- Keep markdown headings short and consistent. +- Avoid unrelated changes in the same pull request. + +## Before you submit + +- Re-read the bounty or issue instructions. +- Verify the file renders cleanly on GitHub. +- Double-check that the PR title clearly describes the change.