Thanks for your interest in contributing! π»π
Whether you're fixing bugs, writing tests, or improving documentation, all contributions are welcome.
- Fork this repository
- Clone your fork:
git clone https://github.com/your-username/project-name.git cd project-name - Create a new branch:
git checkout -b feature/your-feature-name
- Follow PEP8 coding style.
- We use Ruff to ensure code quality:
ruff check
- Tests are written using unittest. To run all tests:
python3 -m unittest discover -s tests
- Add or update tests when fixing bugs or adding features.
Use clear and concise commit messages:
git commit -m "Fix: correct issue with user authentication"- Push your changes:
git push origin feature/your-feature-name
- Open a pull request on the original repository
- Describe your changes clearly
If you find bugs or have suggestions, open an issue with as much detail as possible.