From a8876fbcb8fa2ba3d29030eb9c4d936e2ab9308f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Mon, 8 Jan 2018 12:50:45 +0200 Subject: [PATCH] Add CONTRIBUTING document and pull request template These templates allow for easier pull requests. --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 3 +++ 2 files changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..69af32211 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..ce348d0f0 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -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.