CONTRIBUTING.md

   1 Contributing to PowerDNS
   2 ------------------------
   3 Thank you for you interest to contribute to the PowerDNS project. This document
   4 will explain some of the things you need to keep in mind when contributing to
   5 ease the workflow of this.
   6
   7 # Issue Tracker
   8 When you post an issue or feature request to the
   9 [issue tracker](https://github.com/PowerDNS/pdns/issues), make sure this hasn't
  10 been reported before. If there is an open issue, add extra information on this
  11 issue or show that you have the same issue/want this feature by adding a `:+1:`.
  12
  13 If there is no similar issue, feature request or you're not sure, open a new
  14 issue.
  15
  16 ## Filing a Feature Request
  17 When filing a feature request, please start your issue title with "Feature request:",
  18 this allows for quick distinguishing between issues and these requests.
  19
  20 Please be as elaborate as possible when describing the feature you need. Provide
  21 at least the following information (if they are relevant):
  22
  23 * Use case (what is the 'masterplan' that requires this feature)
  24 * Description of what the feature should do
  25
  26 ## Filing an Issue or Bug
  27 **Note:** if you're planning to file a security bug, look at our
  28 [Security Policy](https://doc.powerdns.com/md/security/) first.
  29
  30 When filing an issue or bug report, make the title of the issue a very short
  31 summary (e.g. "Recursor crash when some-setting is set to 'crash'"). In the
  32 content of the issue, be as detailed as possible. Supply at least the following
  33 information:
  34
  35 * PowerDNS version
  36 * Where you got the software from (e.g. distribution, compiled yourself)
  37 * Operating System and version
  38 * Steps to reproduce: How can we reproduce the issue
  39 * Expected behavior: what did you expect what would happen?
  40 * Observed behavior: what actually happened when following the steps?
  41 * Relevant logs: Please use code blocks (\`\`\`) to format console output, logs, and code as it's very hard to read otherwise.
  42
  43 If you have already looked deeper into the problem, provide what you found as
  44 well.
  45
  46 # Filing a Pull Request
  47 Code contributions are sent as a pull request on [GitHub](https://github.com/PowerDNS/pdns/pulls).
  48 By submitting a Pull Request you agree to your code become GPLv2 licensed.
  49
  50 ## Pull Request Guidelines
  51 A pull request, at the least, should have:
  52
  53 * A clear and concise title (not e.g. 'Issue #1234')
  54 * A description of the patch (what issue does it solve or what feature does it add)
  55 * Documentation for the feature or when current behaviour changes
  56 * Regression and/or unit tests
  57
  58 And must:
  59 * Be filed against the master branch before any release branch
  60 * Pass all tests in Travis
  61
  62 Information on the tests can be found in the repository at
  63 [/regression-tests/README.md](https://github.com/PowerDNS/pdns/blob/master/regression-tests/README.md)
  64 and
  65 [/regression-tests.recursor/README.md](https://github.com/PowerDNS/pdns/blob/master/regression-tests.recursor/README.md).
  66
  67 ## Commit Guidelines
  68 * Tell why the change does what it does, not how it does it.
  69 * The first line should be short (preferably less than 50 characters)
  70 * The rest of the commit body should be wrapped at 72 characters (see [this](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for more info)
  71 * If this commit fixes an issue, put "Closes #XXXX" in the message
  72 * Do not put whitespace fixes/cleanup and functionality changes in the same commit
  73
  74 # Coding Guidelines
  75 At the moment there is no established coding guideline, but here are some
  76 general guidelines:
  77
  78 * Don't have end-of-line whitespace
  79 * Use spaces instead of tabs
  80 * Stick to the style of the file you're editing
  81 * Functions and classes must have a [docblock](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html)