github.com/blystad/deis@v0.11.0/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  - IRC: #[deis](irc://irc.freenode.org:6667/#deis) IRC channel on freenode.org
    18  
    19  ## Getting Started
    20  
    21  - Fork the repository on GitHub
    22  - Read the README.md for build instructions
    23  
    24  ## Contribution Flow
    25  
    26  This is a rough outline of what a contributor's workflow looks like:
    27  
    28  - Create a topic branch from where you want to base your work. This is usually master.
    29  - Make commits of logical units.
    30  - Make sure your commit messages are in the proper format, see below
    31  - Push your changes to a topic branch in your fork of the repository.
    32  - Submit a pull request
    33  
    34  Thanks for your contributions!
    35  
    36  ### Commit Style Guideline
    37  
    38  We follow a rough convention for commit messages borrowed from CoreOS, who borrowed theirs
    39  from AngularJS. This is an example of a commit:
    40  
    41      feat(scripts/test-cluster): add a cluster test command
    42  
    43      this uses tmux to setup a test cluster that you can easily kill and
    44      start for debugging.
    45  
    46  To make it more formal, it looks something like this:
    47  
    48  
    49      {type}({scope}): {subject}
    50      <BLANK LINE>
    51      {body}
    52      <BLANK LINE>
    53      {footer}
    54  
    55  The {scope} can be anything specifying place of the commit change.
    56  
    57  The {subject} needs to use imperative, present tense: “change”, not “changed” nor
    58  “changes”. The first letter should not be capitalized, and there is no dot (.) at the end.
    59  
    60  Just like the {subject}, the message {body} needs to be in the present tense, and includes
    61  the motivation for the change, as well as a contrast with the previous behavior. The first
    62  letter in a paragraph must be capitalized.
    63  
    64  All breaking changes need to be mentioned in the {footer} with the description of the
    65  change, the justification behind the change and any migration notes required.
    66  
    67  Any line of the commit message cannot be longer than 72 characters, with the subject line
    68  limited to 50 characters. This allows the message to be easier to read on github as well
    69  as in various git tools.
    70  
    71  The allowed {types} are as follows:
    72  
    73      feat -> feature
    74      fix -> bug fix
    75      docs -> documentation
    76      style -> formatting
    77      ref -> refactoring code
    78      test -> adding missing tests
    79      chore -> maintenance
    80  
    81  ### More Details on Commits
    82  
    83  For more details see the [commit style guide][style-guide].
    84  
    85  [dco]: DCO
    86  [style-guide]: http://docs.deis.io/en/latest/contributing/standards/#commit-style-guide