github.com/inflatablewoman/deis@v1.0.1-0.20141111034523-a4511c46a6ce/CONTRIBUTING.md (about)

     1  # How to Contribute
     2  
     3  The Deis project is Apache 2.0 licensed and accepts contributions via Github pull
     4  requests. This document outlines some of the conventions on commit message formatting,
     5  contact points for developers and other resources to make getting your contribution
     6  accepted.
     7  
     8  # Certificate of Origin
     9  
    10  By contributing to this project you agree to the
    11  [Developer Certificate of Origin (DCO)][dco]. This document was created by the Linux
    12  Kernel community and is a simple statement that you, as a contributor, have the legal
    13  right to make the contribution.
    14  
    15  # Support Channels
    16  
    17  Before opening a new issue, it's helpful to search the project - it's likely that another user
    18  has already reported the issue you're facing, or it's a known issue that we're already aware of.
    19  
    20  Additionally, see the [Troubleshooting Deis][troubleshooting] documentation for common issues.
    21  
    22  Our official support channels are:
    23  
    24  - GitHub issues: https://github.com/deis/deis/issues/new
    25  - IRC: #[deis](irc://irc.freenode.org:6667/#deis) IRC channel on freenode.org
    26  
    27  When opening an issue or asking for help on IRC, it's helpful to provide debug output from your cluster.
    28  Run `/opt/bin/deis-debug-logs` on one of your CoreOS machines and provide the output to us in a [gist](https://gist.github.com/).
    29  
    30  ## Getting Started
    31  
    32  - Fork the repository on GitHub
    33  - Read the README.md for build instructions
    34  
    35  ## Contribution Flow
    36  
    37  This is a rough outline of what a contributor's workflow looks like:
    38  
    39  - Create a topic branch from where you want to base your work. This is usually master.
    40  - Make commits of logical units.
    41  - Make sure your commit messages are in the proper format, see below
    42  - Push your changes to a topic branch in your fork of the repository.
    43  - Submit a pull request
    44  
    45  Thanks for your contributions!
    46  
    47  ### Commit Style Guideline
    48  
    49  We follow a rough convention for commit messages borrowed from CoreOS, who borrowed theirs
    50  from AngularJS. This is an example of a commit:
    51  
    52      feat(scripts/test-cluster): add a cluster test command
    53  
    54      this uses tmux to setup a test cluster that you can easily kill and
    55      start for debugging.
    56  
    57  To make it more formal, it looks something like this:
    58  
    59  
    60      {type}({scope}): {subject}
    61      <BLANK LINE>
    62      {body}
    63      <BLANK LINE>
    64      {footer}
    65  
    66  The {scope} can be anything specifying place of the commit change.
    67  
    68  The {subject} needs to use imperative, present tense: “change”, not “changed” nor
    69  “changes”. The first letter should not be capitalized, and there is no dot (.) at the end.
    70  
    71  Just like the {subject}, the message {body} needs to be in the present tense, and includes
    72  the motivation for the change, as well as a contrast with the previous behavior. The first
    73  letter in a paragraph must be capitalized.
    74  
    75  All breaking changes need to be mentioned in the {footer} with the description of the
    76  change, the justification behind the change and any migration notes required.
    77  
    78  Any line of the commit message cannot be longer than 72 characters, with the subject line
    79  limited to 50 characters. This allows the message to be easier to read on github as well
    80  as in various git tools.
    81  
    82  The allowed {types} are as follows:
    83  
    84      feat -> feature
    85      fix -> bug fix
    86      docs -> documentation
    87      style -> formatting
    88      ref -> refactoring code
    89      test -> adding missing tests
    90      chore -> maintenance
    91  
    92  ### More Details on Commits
    93  
    94  For more details see the [commit style guide][style-guide].
    95  
    96  [dco]: DCO
    97  [style-guide]: http://docs.deis.io/en/latest/contributing/standards/#commit-style-guide
    98  [troubleshooting]: http://docs.deis.io/en/latest/troubleshooting_deis/