Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 2.85 KB

CONTRIBUTING.markdown

File metadata and controls

58 lines (45 loc) · 2.85 KB
Raw

How to contribute

I'd love to accept your patches and contributions to this project. There are a just a few small guidelines you need to follow.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. Go makes it very simple to ensure properly formatted code, so always run go fmt on your code before committing it. You should also run golint over your code. As noted in the golint readme, it's not strictly necessary that your code be completely "lint-free", but this will help you find common style issues.

  4. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it. gocov and gocov-html are invaluable tools for seeing which parts of your code aren't being exercised by your tests.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  6. Finally, push the commits to your fork and submit a pull request.

Other notes on code organization

Currently, everything is defined in the main librato package, with API methods broken into separate service objects. These services map directly to how the Librato API documentation is organized, so use that as your guide for where to put new methods.

Sub-service (e.g. Space Charts) implementations are split into separate files based on the APIs they provide. These files are named service_api.go (e.g. spaces_charts.go) to describe the API to service mappings.