From 76d09a54c97b4ee1edc0e81184f4f1b7dc138d2e Mon Sep 17 00:00:00 2001 From: Pieter Lexis Date: Fri, 10 Jul 2015 15:15:23 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bce0e6d34c0..cfc7d5e9b824 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ content of the issue, be as detailed as possible. Supply at least the following information: * PowerDNS version -* Where you got the software from (e.g. distribution, compiled youself) +* Where you got the software from (e.g. distribution, compiled yourself) * Operating System and version * Steps to reproduce: How can we reproduce the issue * Expected behavior: what did you expect what would happen? @@ -45,11 +45,12 @@ well. # Filing a Pull Request Code contributions are sent as a pull request on [GitHub](https://github.com/PowerDNS/pdns/pulls). +By submitting a Pull Request you agree to your code become GPLv2 licensed. ## Pull Request Guidelines A pull request, at the least, should have: -* A clear and consise title (not e.g. 'Issue #1234') +* A clear and concise title (not e.g. 'Issue #1234') * A description of the patch (what issue does it solve or what feature does it add) * Documentation for the feature or when current behaviour changes * Regression and/or unit tests @@ -72,9 +73,9 @@ and # Coding Guidelines At the moment there is no established coding guideline, but here are some -general guidleines: +general guidelines: * Don't have end-of-line whitespace * Use spaces instead of tabs * Stick to the style of the file you're editing - +* Functions and classes must have a [docblock](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html)