Hello! Thank you for your interest in contributing to this project. I am always open to any help, whether it's fixing bugs, adding new features, improving documentation, or just sharing fresh ideas.
This document is not a strict set of rules, but a simple guide on how we can comfortably and productively work together.
- Found a bug? Open an Issue and briefly describe what went wrong and how to reproduce it.
- Have a cool idea? Create an Issue with your proposal. It's always best to discuss an idea first before spending time writing code.
- Improving documentation. Fixing typos, expanding instructions, or translating — absolutely any help is valuable.
- Ready to write code? Feel free to fork the repository and open a Pull Request.
The workflow here is as straightforward as possible:
- Fork this repository.
- Create a new branch for your changes (
git checkout -b feature/my-awesome-ideaorgit checkout -b bugfix/issue-123). - Make your changes and commit them (
git commit -m "Add new awesome feature"). - Push the changes to your fork (
git push origin feature/my-awesome-idea). - Open a Pull Request to this repository.
- Try to stick to the code style already used in the project.
- Make your commit messages clear so it's easy to understand what changed.
- If your Pull Request resolves a specific Issue, mention its number in the description (e.g.,
Closes #42). - If the logic changes, please update the relevant section in the README.
I try to review all Issues and Pull Requests as quickly as possible. If I haven't replied in a while, don't hesitate to ping me in the comments.
The main rule is mutual respect. Welcome, and thank you for your contribution!