CONTRIBUTING.md

   1 # Contribution guidelines
   2 Project will probably be moved to ONAP Gerrit repository. Thus, please follow ONAP contribution guidelines.
   3
   4 ## Merging
   5
   6 First of all let's avoid merge commits. To achieve it we should:
   7
   8 * rebase master changes to task branches,
   9 * manually merge task branches to master with `--ff-only option`.
  10
  11 The last part needs some comment. In Gerrit master history is linear and easy to follow. That is probably the greatest (only? :wink:) advantage of Gerrit over GitLab. In GitLab EE it is possible to configure MRs so merge commits are avoided. However in GitLab CE it is not possible. To mitigate this, we should manually merge branches into master.
  12
  13 Some commands which you might find useful:
  14
  15 ```shell
  16 # 1. Update master
  17 git checkout master
  18 git fetch
  19 git merge -ff-only
  20
  21 # 2. Rebase branch on fresh master
  22 git checkout $BRANCH
  23 git rebase -i master
  24 git push --force
  25
  26 # 3. Merge branch
  27 git checkout master
  28 git merge --ff-only $BRANCH
  29 git branch -d $BRANCH
  30 git push origin --delete $BRANCH
  31 git push
  32
  33 ```
  34
  35 ## Sign-off rules
  36 Each commit has to be signed-off. By signing the commit you certify that you did follow rules defined in the document https://gerrit.onap.org/r/static/signoffrules.txt:
  37
  38 ```
  39 Sign your work
  40
  41 To improve tracking of who did what, especially with contributions that
  42 can percolate to their final resting place in the code base through
  43 several layers of maintainers, we've introduced a "sign-off" procedure
  44 on all contributions submitted.
  45
  46 The sign-off is a simple line at the end of the explanation for the
  47 contribution, which certifies that you wrote it or otherwise have the
  48 right to pass it on as an open-source contribution. When you sign-off
  49 your contribution you are stating the following:
  50
  51     By making a contribution to this project, I certify that:
  52
  53     (a) The contribution was created in whole or in part by me and I
  54         have the right to submit it under the open source license
  55         indicated in the file; or
  56
  57     (b) The contribution is based upon previous work that, to the best
  58         of my knowledge, is covered under an appropriate open source
  59         license and I have the right under that license to submit that
  60         work with modifications, whether created in whole or in part
  61         by me, under the same open source license (unless I am
  62         permitted to submit under a different license), as indicated
  63         in the file; or
  64
  65     (c) The contribution was provided directly to me by some other
  66         person who certified (a), (b) or (c) and I have not modified
  67         it.
  68
  69     (d) I understand and agree that this project and the contribution
  70         are public and that a record of the contribution (including all
  71         personal information I submit with it, including my sign-off) is
  72         maintained indefinitely and may be redistributed consistent with
  73         this project or the open source license(s) involved.
  74 ```