Thank you for investing your time in contributing to our project!
To start off, read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README.
If you spot a problem with dart_apitool, ensure that the bug was not already reported by searching on GitHub under Issues.
Here is a guide for how to search effectively on GitHub.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and a clear description, as much relevant information as possible.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you are only interested in solving bugs then please check out all our open bugs.
If you find an issue to work on, you are more than welcome to open a PR with a fix.
-
Once you think you're done coding, open a new pull request. Target the
mainbranch. We are doing trunk based development. -
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
-
Once the pipeline becomes green and you have the required review approvals, then feel free to squash and merge your PR.
Check out the existing enhancement issues and make sure that a similar suggestion does not already exist.
If you're unable to find an open issue addressing the suggestion, open a new one. Be sure to include as much relevant information as possible.
We will try to comment and give you feedback on your suggestion as a soon as possible. If you're excited about your idea and cannot wait for feedback to start, then feel free to start coding right away.
But please note that we cannot guarantee that your suggestion will be accepted.
Thanks again for investing your time in contributing to our project!