3.4 KiB
💁 Contributing to this project
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 to this project. Use your best judgment and feel free to propose changes to this document in a pull request.
💡 Your contribution - the sky is the limit 🌈
This is an open source project and we love to receive contributions from our community — you!
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the repository itself.
When contributing to this project, please feel free to discuss the change you wish to make via issue with the repository owners before making a change.
🐞 You want to report a bug or file 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 met
- Submit the patch and await review.
🆕 You want to suggest a new feature?
☑️ Your responsibilities
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports.
- Ensure coding conventions are met. Lint your code with the project's default tools.
- Add tests for your feature that proove it's working as expected. Code coverage should not drop below it's previous value.
- Ensure none of the existing tests are failing after adding your changes.
- Document your public API code and ensure to add code comments where necessary.