CONTRIBUTING.md

   1 # Contributing to the OpenDaylight Ansible Role
   2
   3 We work to make contributing easy. Please let us know if you spot something we can do better.
   4
   5 #### Table of Contents
   6
   7 1. [Overview](#overview)
   8 2. [Communication](#communication)
   9    - [Issues](#issues)
  10    - [IRC channel](#irc-channel)
  11 3. [Patches](#patches)
  12
  13 ## Overview
  14
  15 We use [GitHub Issues][1] for most communication, including bug reports, feature requests and questions.
  16
  17 We accept patches via [GitHub Pull Requests][2]. Please fork our repo, make your changes, commit them to a feature branch and *submit a PR to have it merged back into this project*. We'll give feedback and get it merged ASAP.
  18
  19 ## Communication
  20
  21 *Please use public, documented communication instead of reaching out to developers 1-1.*
  22
  23 Open Source projects benefit from always communicating in the open. Previously answered questions end up becoming documentation for other people hitting similar issues. More eyes may get your question answered faster. Doing everything in the open keeps community members on an equal playing field (`@<respected company>` email addresses don't get priority, good questions do).
  24
  25 We prefer [Issues][1] for most communication.
  26
  27 ### Issues
  28
  29 Please use our [GitHub Issues][1] freely, even for small things! They are the primary method by which we track what's going on in the project.
  30
  31 The labels assigned to an issue can tell you important things about it.
  32
  33 For example, issues tagged [`good-for-beginners`][3] are likely to not require much background knowledge and be fairly self-contained, perfect for people new to the project who are looking to get involved.
  34
  35 The priority-related issue labels ([`prio:high`][4], [`prio:normal`][5]...) are also important to note. They typically accurately reflect the next TODOs the community will complete.
  36
  37 The `info:progress` labels may not always be up-to-date, but will be used when appropriate (typically long-standing issues that take multiple commits).
  38
  39 Issues can be referenced and manipulated from git commit messages. Just referencing the issue's number (`#42`) will link the commit and issue. Issues can also be closed from commit messages with `closes #42` (and [a variety of other key words][6]).
  40
  41 ### IRC channel
  42
  43 Feel free to join us at **#opendaylight-integration** on `chat.freenode.net`. You can also use web client for Freenode to join us at [webchat][10].
  44
  45 ## Patches
  46
  47 Please use [Pull Requests][2] to submit patches.
  48
  49 Basics of a pull request:
  50
  51 - Use the GitHub web UI to fork our repo.
  52 - Clone your fork to your local system.
  53 - Make your changes.
  54 - Commit your changes, using a [good commit message][8] and referencing any applicable issues.
  55 - Push your commit.
  56 - Submit a pull request against the project, again using GitHub's web UI.
  57 - We'll give feedback and get your changed merged ASAP.
  58 - You contributed! [Thank you][9]!
  59
  60 Other tips for submitting excellent pull requests:
  61
  62 - If you'd like to make more than one logically distinct change, please submit them as different pull requests (if they don't depend on each other) or different commits in the same PR (if they do).
  63 - If your PR contains a number of commits that provide one logical change, please squash them using `git rebase`.
  64 - If applicable, please provide documentation updates to reflect your changes.
  65
  66 [1]: https://github.com/dfarrell07/ansible-opendaylight/issues
  67
  68 [2]: https://github.com/dfarrell07/ansible-opendaylight/pulls
  69
  70 [3]: https://github.com/dfarrell07/ansible-opendaylight/labels/good-for-beginners
  71
  72 [4]: https://github.com/dfarrell07/ansible-opendaylight/labels/prio%3Ahigh
  73
  74 [5]: https://github.com/dfarrell07/ansible-opendaylight/labels/prio%3Anormal
  75
  76 [6]: https://help.github.com/articles/closing-issues-via-commit-messages/
  77
  78 [8]: http://chris.beams.io/posts/git-commit/
  79
  80 [9]: http://cdn3.volusion.com/74gtv.tjme9/v/vspfiles/photos/Delicious%20Dozen-1.jpg
  81
  82 [10]: http://webchat.freenode.net/?channels=opendaylight-integration