Thank you for taking the time to contribute to this project! We value your input and hope the following guidelines will help you understand how best to collaborate with us.
Please follow our Code of Conduct in all your interactions with the project. We aim to foster an inclusive, welcoming, and friendly environment for everyone.
There are several ways you can contribute to the project:
If you find a bug, please create an issue using the issue template provided. Be sure to include:
- A clear and descriptive title
- A step-by-step description of how to reproduce the issue
- Details about your environment (e.g., operating system, browser, etc.)
If you have an idea for a new feature or an improvement, please submit an issue and describe your idea in detail.
Before submitting any changes, please open an issue to discuss what you would like to change or improve. This will help prevent duplicate work and ensure that your contributions align with the project’s goals.
Once your contribution is approved, please follow this workflow to submit your code:
- Fork the repository and clone it locally.
- Create a new branch for your feature or bug fix (
git checkout -b feature-name). - Commit your changes with clear and concise commit messages.
- Ensure all tests pass before submitting.
- Submit a pull request and provide a detailed description of the changes.
Follow the project's coding style to maintain consistency:
- Use meaningful and self-descriptive variable/function names.
- Write comments for complex sections of code.
- Follow the established formatting rules (indentation, spacing, etc.).