Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (26 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.45 KB
Raw

Contributing to Touti Cracker

Thank you for your interest in contributing to Touti Cracker! We welcome all types of contributions, including bug fixes, new features, and improvements.

How to Contribute

  1. Fork the repository – Start by forking the repository on GitHub.
  2. Clone your fork locally – Clone your fork to your local machine.
  3. Create a new branch – Create a new branch for your changes.
  4. Make your changes – Implement your changes and ensure they work properly.
  5. Submit a Pull Request – Once your changes are ready, submit a pull request with a clear description of the changes you’ve made.

Code Style

  • Please follow Python’s PEP 8 for code styling.
  • Use descriptive variable and function names.
  • Ensure your code passes all tests and does not break any existing functionality.

Testing

  • Add unit tests for new features or bug fixes.
  • Make sure all existing tests pass before submitting a pull request.

Reporting Issues

If you find a bug or would like to report an issue, please open a new issue with the following details:

  • Steps to reproduce the issue.
  • Your development environment (OS, Python version, etc.).
  • Any error messages encountered.

Code of Conduct

We expect all contributors to follow our Code of Conduct.

License

This project is licensed under the MIT License.

Thank you for helping us improve Touti Cracker!