CONTRIBUTING.rst

How to contribute

Welcome to coala! The following guidelines will give you a short overview over how we handle issues and PRs in this repository. coala is maintained by a growing community and newcomers are always welcome!

We appreciate all valuable contributions - bug reports, documentation and design enhancements issues as well as pull Requests to make coala more convenient, functional and bug free.

To begin contributing have a look at the open issues labeled with difficulty/newcomer - newcomer issues.

Follow the instructions here and get involved to help us make a better software.

Filing Issues

When filing an issue, please use this template:

### Overview Description

# Steps to Reproduce

1.
2.
3.

# Actual Results

# Expected Results

# Reproducibility

# Additional Information:

PR Merge Criteria

For a PR to be merged, the following statements must hold true:

• All CI services pass. (CircleCI, AppVeyor, Scrutinizer, CodeCov)
• All commits must have been reviewed and approved by GitMate and a coala maintainer who is not the author of the PR.
• Commits shall comply to the commit guidelines as outlined in the docs.

Commit guidelines can be found at the Good Commits page

Correcting PRs

Rebasing PRs is preferred over merging master into the source branches again and again cluttering our history. If a reviewer has suggestions, the commit shall be amended so the history is not cluttered by “fixup commits”.

For further information/queries feel free to discuss with us on gitter.