We’re happy you’re considering contributing to the Write.as command-line client!
It won’t take long to get up to speed on this. Here are our development resources:
We try to write tests for all parts of the CLI, but aren’t there yet. While not required, including tests with your new code will bring us closer to where we want to be and speed up our review.
Please send a pull request with a clear list of what you’ve done.
Please follow our coding conventions below and make sure all of your commits are atomic. Larger changes should have commits with more detailed information on what changed, any impact on existing code, rationales, etc.
We strive for consistency above all. Reading the small codebase should give you a good idea of the conventions we follow.
goimports
before committing anythingWe aim for two import groups:
goimports
already does this for you along with running go fmt
.
We maintain a few high-level design principles in all decisions we make. Keep these in mind while devising new functionality: