Then, look at our Go (Golang) coding guidelines and the Google Go Code Review guide it links to. These are linked to from the other pages in this wiki, but they're easy to miss. If you haven't written any Go before CockroachDB, you may want to hold off on reviewing the style guide until you've written your first few functions in go.
Fix your style violations
First, read the Go (Golang) coding guidelines again, looking for any style violations. It's easier to remember a style rule once you've violated it.
Be kind to other developers, including your future self, by splitting large commits. Each commit should represent one logical change to the codebase with a descriptive message that explains the rationale for the change.This is explained in our PR organization philosophy.
On your first PR, it's worth re-reading the Git Commit Messages page to ensure your commit messages follow the guidelines.
- Create a GitHub fork of cockroachdb/cockroach
- Read through the contributor guide in this wiki
- Submitting your first PR
- Push to a feature branch on your personal fork
- Verify you've followed the Go (Golang) coding guidelines
- Verify you've read What is a Good CockroachDB PR
- Verify you've read Submitting your contribution
- Ensure files you've added, if any, have a license block
- Run make check
- Split your change into logical commits with good messages
- Addressing feedback
- Amend the appropriate commits and force-push
- Respond to all feedback with "Done" or a counterargument
bors r=reviewerto ask Craig to merge