Thank you for considering contributing to our project! We welcome any form of contribution, whether it's reporting issues, suggesting improvements, or submitting code changes.
Please take a moment to review the following guidelines before you get started:
If you encounter a bug or have a feature request, please open an issue on the repository. Make sure to include:
- A clear and descriptive title.
- A detailed description of the issue or feature request.
- Steps to reproduce the issue (if applicable).
- Any relevant error messages or screenshots.
-
Fork the repository to your GitHub account.
-
Clone the forked repository to your local machine.
-
Create a new branch for your changes:
git checkout -b feature/your-feature
Use a descriptive name for your branch (e.g.,
feature/new-feature). -
Make your changes and ensure they follow the project's coding style and conventions.
-
Write appropriate tests for your changes (if applicable).
-
Ensure all existing tests pass successfully.
-
Commit your changes with a clear and concise message:
git commit -m "Brief description of your changes" -
Push your changes to your forked repository:
git push origin feature/your-feature
-
Open a pull request (PR) on the original repository.
- Provide a descriptive title and detailed description of your changes.
- Link any relevant issues in the PR description.
-
Your PR will be reviewed, and you may be asked to make further changes.
Please note that we have a Code of Conduct that we expect all contributors to follow. Make sure you are familiar with its contents.
We appreciate your contribution and look forward to working with you! If you have any questions or need further assistance, please don't hesitate to reach out.
Happy coding! 🚀