Contributing

Thanks for your interest in contributing!

There are many ways to contribute:

Refactoring code
Fixing bugs, after reporting them
Building new features, based on the roadmap in README and related Github issues.

Guidelines

Fork the project and clone locally. Follow "Getting Started" in README
Create a branch
Code and commit your changes. Good commit messages are always appreciated!
Push to the branch
Create a pull request for your branch

Creating issues

When filing an issue, make sure to follow this template:

Go version
Operating system and processor architecture
Steps to reproduce
Expected behavior
Actual behavior

Testing

Tests are required for contributions. Please refer to "Testing" section in README to write and run tests.

Creating a pull request

Keep the pull requests concise
Make sure all tests pass
Document your code with comments and update existing documentation if needed (now using API Blueprint but soon using OpenAPI)
Refer issue related to the pull request if it exists

Further help

Create an issue and mention the author @blushi