ceph/src/boost/libs/hana/CONTRIBUTING.md

   1 # How to contribute
   2
   3 Contributions are always very much appreciated. However, to make sure the
   4 process of accepting patches goes smoothly for everyone (especially for
   5 the maintainer), you should try to follow these few simple guidelines when
   6 you contribute:
   7
   8 1. Fork the repository.
   9 2. Create a new branch based on the `develop` branch (`git checkout -b your_branch develop`).
  10    If your contribution is a bug fix, you should name your branch `bugfix/xxx`;
  11    for a feature, it should be `feature/xxx`. Otherwise, just use your good
  12    judgment. Consistent naming of branches is appreciated since it makes the
  13    output of `git branch` easier to understand with a single glance.
  14 3. Do your modifications on that branch. Except for special cases, your
  15    contribution should include proper unit tests and documentation. Also,
  16    please try to follow the style guide below.
  17 4. Make sure your modifications did not break anything by building and
  18    running the tests:
  19
  20    ```shell
  21    make check
  22    ```
  23 5. Commit your changes. Your commit message should start with a one line
  24    short description of the modifications, with the details and explanations
  25    of your modifications following in subsequent paragraphs or bullet points.
  26    Please limit your lines to about 78 characters in commit messages, since
  27    it makes the output easier to read in `git log`. Also, starting your commit
  28    message with a tag describing the nature of the commit is nice, since it
  29    makes the commit history easier to skim through. For commits that do not
  30    change any functionality (e.g. refactoring or fixing typos), the `[NFC]`
  31    tag (No Functionality Change) can be used. Here's an example of an
  32    acceptable commit message:
  33    ```
  34    [Searchable] Refactor the interface
  35
  36    - Rename elem to contains
  37    - Rename subset to is_subset, and make is_subset applicable in infix notation
  38    - Add the at_key method
  39    - operator[] is now bound to at_key instead of find
  40    ```
  41    When applicable, please squash adjacent _wip_ commits into a single
  42    _logical_ commit. If your contribution has several logical commits,
  43    it's fine.
  44 6. Push the changes to your fork (`git push origin your_branch`).
  45 7. Open a pull request against Hana's `develop` branch (not against `master`).
  46    I will do my best to respond in a timely manner. I might discuss your patch
  47    and suggest some modifications, or I might amend your patch myself and ask
  48    you for feedback. You will always be given proper credit.
  49
  50
  51 ## Style guide
  52
  53 I'm not going to write an exhaustive style guide, but here are a couple of
  54 points you should watch out for:
  55 - Indent using 4 spaces.
  56 - Do not leave trailing white spaces at the end of lines, and no more than a
  57   single newline at the end of a source file.
  58 - Hana's `#include`s go first, then a blank line and system headers.
  59   `#include`s within each block should be sorted in alphabetical order.
  60 - Use your own judgment and stick to the style of the surrounding code.