# Contributing to Tessellate

**Thank you for your interest in making Tessellate even better and more awesome. Your contributions are highly welcome.**

There are multiple ways of getting involved:

- [Report a bug](#report-a-bug)
- [Suggest a feature](#suggest-a-feature)
- [Contribute code](#contribute-code)

Below are a few guidelines we would like you to follow.
If you need help, please reach out to one or more of the [maintainers](https://github.com/zalando-incubator/tessellate/blob/master/MAINTAINERS).

## Report a bug
Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an [issue](https://github.com/zalando-incubator/tessellate/issues) reporting the same problem does not already exist. If there is an such an issue, you may add your information as a comment.

To report a new bug you should open an issue that summarizes the bug and set the label to "bug".

If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code](#contribute-code).

## Suggest a feature
To request a new feature you should open an [issue](https://github.com/zalando-incubator/tessellate/issues/new) and summarize the desired functionality and its use case. Set the issue label to "feature".  

## Contribute code
This is a rough outline of what the workflow for code contributions looks like:
- Check the list of open [issues](https://github.com/zalando-incubator/tessellate/issues). Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work. This is usually master.
- Make commits of logical units.
- Write good commit messages (see below).
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to [zalando-incubator/tessellate](https://github.com/zalando-incubator/tessellate)
- Your pull request must receive a :thumbsup: from at least one [maintainer](https://github.com/zalando-incubator/tessellate/blob/master/MAINTAINERS)

Unless you explicitly state otherwise in advance, any non trivial contribution intentionally submitted for inclusion in this project by you to the steward of this repository (Zalando SE, Berlin) shall be under the terms and conditions of the [MIT License](LICENSE), without any additional copyright information, terms or conditions.

Thanks for your contributions!

### Commit messages
Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the "what" and the body of the commit should describe the "why".  

Tessellate uses [commitizen](https://github.com/commitizen/cz-cli) and [cz-lerna-changelog](https://github.com/atlassian/cz-lerna-changelog) to format commit messages.

```
npm install -g commitizen
```

Now you can use `git cz` instead of `git commit`.

When creating a pull request, its comment should reference the corresponding issue id.

### Before you commit

Be sure that the code passes all tests before submitting your pull request:

* Formatting. Run `npm run prettier`.
* Linting. Run `npm run lint`.
* Tests. Run `npm test`.
* Static checking. Run `npm run flow-check`.

### Creating releases

Tessellate uses [lerna-semantic-release](https://github.com/atlassian/lerna-semantic-release)
to release new versions automatically.

*  Commits of type `fix` will trigger bugfix releases, think `0.0.1`
*  Commits of type `feat` will trigger feature releases, think `0.1.0`
*  Commits with `BREAKING CHANGE` in body or footer will trigger breaking releases, think `1.0.0`

All other commit types will trigger no new release.

**Have fun and enjoy hacking!**