First off, thanks for taking the time to contribute!
The process to contribute is straightforward:
- Check for Existing Issues: Use the search bar to check if the issue you're looking to solve or the feature you're looking to implement is already reported or requested. If the issue or feature has already been reported/requested and is still open, you can leave a comment indicating that you're working on it.
- Create an Issue: If your issue or feature request is not already listed, you can create a new one. Be sure to include the following information:
- A short, descriptive title.
- A detailed description of the issue or feature you want to work on. The more specific, the better.
- Any additional context or screenshots (if applicable).
- Fork the Repository: If you're ready to contribute, start by forking the repository so you have a copy that you have full control over. Clone it to your local machine.
- Test your Changes: Please make sure to test your changes thoroughly ensuring they don't break any existing functionality.
- Test your Changes: Please make sure to test your changes thoroughly ensuring they don't break any existing functionality.
- Push your Changes: Once your changes are tested, commit them and push your branch to your forked repository.
- Create a Pull Request (PR): Open a new pull request from your forked repository to this repository. Be sure to follow the pull request template and complete all relevant sections. Tag any associated Issues in your PR description.
Your pull request will be merged, assuming it meets the criteria mentioned above and it doesn't have any conflicts.
Please make sure to update the README.md with details of changes to the functionality.