2017-01-02 16:07:06 +01:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
Before starting your work on this module, you should
|
|
|
|
|
[fork the project](https://help.github.com/articles/fork-a-repo/) to your
|
|
|
|
|
GitHub account. This allows you to freely experiment with your changes. When
|
|
|
|
|
your changes are complete, submit a
|
|
|
|
|
[pull request](https://help.github.com/articles/using-pull-requests/). All pull
|
|
|
|
|
requests will be reviewed and merged if they suit some general guidelines:
|
|
|
|
|
|
|
|
|
|
* Changes are located in a topic branch
|
|
|
|
|
* For new functionality, proper tests are written
|
|
|
|
|
* Changes should not solve certain problems on special environments
|
|
|
|
|
|
|
|
|
|
## Issue Tracker
|
|
|
|
|
If you think your changes need further discussion, you found a bug or have a
|
|
|
|
|
feature request, create an issue on [GitHub](https://github.com/Icinga/icingabeat/issues). The issue number should
|
|
|
|
|
be used in your branch name as reference to a certain bug or feature discussion.
|
|
|
|
|
|
|
|
|
|
## Branches
|
|
|
|
|
Choosing a proper name for a branch helps us identify its purpose and possibly
|
|
|
|
|
find an associated bug or feature. Generally a branch name should include a
|
2017-03-15 11:39:01 +01:00
|
|
|
topic such as `fix` or `feature` followed by a description and an issue number
|
2017-01-02 16:07:06 +01:00
|
|
|
if applicable. Branches should have only changes relevant to a specific issue.
|
|
|
|
|
|
|
|
|
|
```
|
2017-03-15 11:39:01 +01:00
|
|
|
git checkout -b fix/field-type-missing-1234
|
2017-01-02 16:07:06 +01:00
|
|
|
git checkout -b feature/new-setting-for-foo-1235
|
|
|
|
|
```
|
