CONTRIBUTING

# Contributing to Zally

We are happy to accept contributions! This is what makes Open Source possible. We ask
that you follow these guidelines when contributing.

## Issues
Found a bug or have an idea for a feature? You can help us by [creating an issue](https://github.com/schweizerischebundesbahnen/zally/issues).
Just make sure that an issue describing the bug or feature does not already exist. You can go even further and
[open a Pull Request](https://github.com/schweizerischebundesbahnen/zally/pulls) with the fix or proposed feature.

## Pull Requests
Follow these steps to contribute your work to Zally:

1. [Open an issue](https://github.com/schweizerischebundesbahnen/zally/issues) describing the problem or proposed feature. Ask maintainers (in the issue thread) to assign the issue to you so we know who is working on what.
1. Fork this repo and create a branch for your work.
1. Push changes to your branch.
1. Test your changes.
1. Open a [Pull Request](https://github.com/schweizerischebundesbahnen/zally/pulls) when your code is ready for review.
    1. Mention the issue number in the comment (e.g. Fixes #37).
1. We will review your PR, give feedback, and merge when it is ready.

Thanks for your contribution!

## Sub-Project Specific

- Please refer to [this document](server/CONTRIBUTING) if contributing to the **Zally Server**