👍🎉 First off, thanks for taking the time to contribute! 🎉👍
All types of contributions are encouraged and valued. If you like the project, but just don’t have time to contribute, that’s fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- ⭐ Star the project
- ✉️ Post about it (e.g. Twitter, LinkedIn, Reddit, etc.)
- 🔗 Refer this project in your project’s readme
- 💬 Mention the project at local meetups and tell your friends/colleagues
Yes.. this is important to read! ⚖️ When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license and enforced laws. You also agree to follow the code of conduct.
Please follow the styleguides below when contributing to this project.
- Use a clear and descriptive title
- Select the appropiate labels
- Provide as many details as possible in the description
- Use the templates (should automatically appear when creating an issue or pull request)
- Use the present tense ("Add feature" not "Added feature")
- Should be named after the issue they are addressing
- e.g. Issue #123 should be addressed in a branch named
123_fix-bug
- e.g. Issue #123 should be addressed in a branch named
- All code should be formatted with Prettier
- Code should be commented where necessary
- Using new packages should be discussed first
- Code should be tested where necessary
- No code should be pushed directly to the
mainbranch (unless it is a hotfix or minor change by the project maintainers) - Refer to the readme for more information on the tech stack of the project and how to set it up
Thank you for reading this far! 🙏 Happy contributing! 🎉