docs: add contributing guide (#3)
Co-authored-by: Grouchly <ubuntclaw@Grouchly.tailbdd0ba.ts.net>
This commit is contained in:
@@ -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.
|
||||
Reference in New Issue
Block a user