2.1 KiB
2.1 KiB
How to contribute
First off, thank you for considering contributing to this project.
It’s people like you that keep this project alive and make it great!
Thank you! 🙏💜🎉👍
The following is a set of guidelines for contributing this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change.
🐞 You found a bug or have an issue?
- Ensure that is was not already reported and is beeing worked on by checking open issues.
- Create a new issue with a clear and descriptive title
- Write a detailed comment with as much relevant information as possible including
- how to reproduce the bug
- a code sample or an executable test case demonstrating the expected behavior that is not occurring
- any files that could help trace it down (i.e. logs)
🩹 You wrote a patch that fixes an issue?
- Open a new pull request (PR) with the patch.
- Ensure the PR description clearly describes the problem and solution.
- Link the relevant issue if applicable (how to link issues in PRs).
- Ensure that no tests are failing and coding conventions are held
- Submit the patch and await review.