Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

26 lines (16 loc) · 1.69 KB

Contributing

Thanks for considering contributing to this project! Contributions of all kinds are welcome — bug reports, feature suggestions, documentation improvements, and code.

If this is your first time contributing to an open source project on GitHub, this guide is a good starting point: How to Contribute to an Open Source Project on GitHub.

Please also read the Code of Conduct — it applies to all interactions in this repository. Security vulnerabilities should be reported privately following SECURITY.md, not as a public Issue.

Reporting a bug

Open an Issue using the bug report template. Include steps to reproduce, what you expected to happen, what actually happened, and your environment (OS, version, etc. — whatever is relevant for this project).

Suggesting an improvement

Open an Issue using the feature request template. Describe the problem you're trying to solve, not just the solution you have in mind — it makes it easier to evaluate alternatives.

Contributing code

  1. Fork the repository and create a branch for your change.
  2. Keep each pull request focused on a single reason for change — don't bundle unrelated fixes together.
  3. If your change relates to an existing Issue, reference it in the pull request description.
  4. Try to match the existing coding style and conventions used in the project.
  5. Describe why the change is needed, not just what it changes — this makes review much faster.
  6. Open the pull request using the provided template.

All contributions are reviewed by a human before being merged; please be patient, this is a personal project maintained in spare time.