Contributing to Hera

June 14, 2018 ยท View on GitHub

Contributions are very much welcomed and appreciated. We want to make contributing to this project as easy and transparent as possible, so please read through and become familiar with these guidelines.

Pull Requests

We use Github Flow for pull requests

When submitting a pull request:

  1. Fork the repo and create your branch from master.
  2. Add tests to your changes whenever possible.
  3. Update the documentation when changing any user-facing behavior.
  4. Submit your PR

Continuous Integration

Hera uses Semaphore to build pull requests. Ensure the build for your PR succeeds and that the tests pass.

Reporting Bugs

Report your bug by creating a new issue in this repository.

Be Descriptive

Great bug reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
    • Include a sample output of your logs if any
  • Notes (possibly including why you think this might be happening, or things you've tried that didn't work)

Use a Consistent Coding Style

Run golint against your code until it reports no issues.

License

By contributing, you agree that your contributions will be licensed under its MIT License.