diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..1e194623a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to logstash-gelf + +If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request. + +When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. +Formatting settings are provided for Eclipse in https://github.com/mp911de/logstash-gelf/blob/master/as7formatter.xml + +## Bugreports + +If you report a bug, please ensure to specify the following: + +* logstash-gelf version (e.g. 1.6.0) +* Contextual information (what were you trying to do using logstash-gelf) +* Simplest possible steps to reproduce + * JUnit tests to reproduce are great but not obligatory + +## License + +By contributing your code, you agree to license your contribution under the terms of [The MIT License (MIT)] (http://opensource.org/licenses/MIT). + +All files are released with the MIT license. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..f09400d9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,16 @@ + +Make sure that: + +- [ ] You have read the [contribution guidelines](https://github.com/mp911de/logstash-gelf/blob/master/.github/CONTRIBUTING.md). +- [ ] You specify the logstash-gelf version and environment so it's obvious which version is affected +- [ ] You provide a reproducible test case (either descriptive of as JUnit test) if it's a bug or the expected behavior differs from the actual behavior. + + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..ef30355c2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ + +Make sure that: + +- [ ] You have read the [contribution guidelines](https://github.com/mp911de/logstash-gelf/blob/master/.github/CONTRIBUTING.md). +- [ ] You use the code formatters provided [here](https://github.com/mp911de/logstash-gelf/blob/master/as7formatter.xml) and have them applied to your changes. Don’t submit any formatting related changes. +- [ ] You submit test cases (unit or integration tests) that back your changes. + + \ No newline at end of file