-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0b0df10
commit 001e879
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing | ||
|
||
Contributions are very welcome. The following will provide some helpful guidelines. | ||
|
||
## How to contribute | ||
|
||
If you want to submit a contribution, please follow the following workflow: | ||
|
||
* Fork the project | ||
* Create a feature branch | ||
* Add your contribution | ||
* When you're completely done, build the project and run all tests. | ||
* Create a Pull Request | ||
|
||
### Commits | ||
|
||
Commit messages should be clear and fully elaborate the context and the reason of a change. | ||
If your commit refers to an issue, please post-fix it with the issue number, e.g. | ||
|
||
``` | ||
Issue: #123 | ||
``` | ||
|
||
Furthermore, commits should be signed off according to the [DCO](DCO). | ||
|
||
### Pull Requests | ||
|
||
If your Pull Request resolves an issue, please add a respective line to the end, like | ||
|
||
``` | ||
Resolves #123 | ||
``` | ||
|
||
### Formatting | ||
|
||
Please adjust your code formatter to the general style of the project. |