First of all, thank you for taking the time to contribute! 🎉
To contribute to this project, please follow the steps below:
- Fork the repository to your GitHub account.
- Clone the repository to your local machine
- Create a new branch for your feature or bugfix
- Install dependencies and Set up the project
- Make your changes!
- Commit your changes with a clear, descriptive message
- Push your branch to your forked repository:
- Create a pull request from your branch to the
main
branch of this repository.
- Follow the existing code style.
- Write clear and concise comments when necessary.
If you find a bug or have a feature request, please open an issue in the Issues section of this repository. Be sure to include:
- A descriptive title
- A detailed explanation of the issue or feature request
- Steps to reproduce the issue, if applicable
- Ensure your code follows the code style and passes all tests.
- Make sure your pull request describes the problem you're solving or the feature you're adding.
- Wait for your pull request to be reviewed by the maintainers. They may ask for changes before merging.
Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
Thank you for contributing! 🎉