First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
And 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
- Tweet about it
- Refer this project in your project's readme
- Mention the project at local meetups and tell your friends/colleagues
This project and everyone participating in it is governed by the Linux Foundation Decentralized Trust Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to Mike Dolan ([email protected]) or Angela Brown ([email protected]).
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
We will then take care of the issue as soon as possible.
If you found a bug in our code or want to suggest a new feature or improvement please create a new Issue.
We reserve issues for people who have never contributed to this project or any open source project in general. We know that creating a pull request (PR) is a major barrier for new contributors. The goal of issues labeled by 'good first issue' is to help you make your first contribution.
This does not mean that contribution is only welcome for those issues. We are happy with any contribution. The most important point is that an issue exists for the contribution. If that is not the case please create an issue for a bug or enhancement. Please comment on the given issue that you want to work on it. Once a member of the team has assigned you to the issue you can start working on it.
This guide is based on the contributing-gen. Make your own!