- Take a look at our open issues, if you are new to this project, look for the ones with the
Good First Issuetag. - Take a look at our projects, if you think there is something you would like to work on that contributes to the project, then feel free to work on it and make a PR!
- You can always reach out to me (hello@czhang.me) or any of the contributors, we can talk about what our next steps are.
- If you have something you would like to work on, or you found a bug, please open an issue if there isn't one already. If the issue is related to a certain project, please tag the project in the issue.
- If you would like to "own" a certain open issue, assign yourself to it.
- Do your work on a feature branch (preferably on your own fork), once you are done, make a PR! Draft PRs are always welcome so that any of the contributors can give you early feedback.
- Make sure to add appropriate tests for any of the code you write, the reviewers will also
remind you if you forget. We use the
gotestspackage to generate test templates. - We follow the standard Go conventions for naming, formatting, etc. Please run
gofmt -s -d .in the project root directory to make sure your format is good. CircleCI will also run agofmttest. - Make sure to mention any of the issues that this PR will close. For example, including "this closes #24" or "this fixes #24" in the PR description means that issue #24 will be closed once this PR is merged.
- If this PR is not related to any issues but is related to a project, please tag the appropriate project in the PR.
- Once someone has approved your PR and your code passes the tests on CircleCI, then feel free to merge it.
- Reviewers: once you approved a PR, please don't merge it and let the author merge it themselves.
- Rinse and repeat :)