Add CONTRIBUTING document and pull request template

These templates allow for easier pull requests.
This commit is contained in:
Markus Mäkelä 2018-01-08 12:50:45 +02:00
parent 0416d66bcb
commit a8876fbcb8
2 changed files with 30 additions and 0 deletions

27
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,27 @@
# Contributing to Maxscale
## Prerequisites
Basically, in order for us to be able to accept a contribution, it must be
licensed under [BSD-new](http://en.wikipedia.org/wiki/BSD_licenses). Upon
request, we can also provide a _contributor agreement_ for you to sign.
When you submit a pull request, add the following comment to your pull request.
> I am contributing the new code of the whole pull request, including one or
several files that are either new files or modified ones, under the BSD-new
license.
Without this comment, the pull request will not be accepted.
## Practicalities
* Please ensure that your pull-request has been made against the correct
branch. For bug fixes or minor improvements, use the default branch and for
new code, use the `develop` branch (e.g. for a patch to 2.1.x, use the `2.1`
branch).
* Please ensure that your code follows our [Coding Style](https://github.com/mariadb-corporation/MaxScale/wiki/Coding-Style-and-Guidelines).
All new code should be formatted with the
[Astyle configuration](https://github.com/mariadb-corporation/MaxScale/wiki/Coding-Style-and-Guidelines#tldr)
provided with the MaxScale source code.

3
PULL_REQUEST_TEMPLATE.md Normal file
View File

@ -0,0 +1,3 @@
I am contributing the new code of the whole pull request, including one or
several files that are either new files or modified ones, under the BSD-new
license.