ContributorGuide.md

   1 # Contributor Guide
   2
   3 The ArmNN project is open for external contributors and welcomes contributions. ArmNN is licensed
   4 under the [MIT license](https://spdx.org/licenses/MIT.html) and all accepted contributions must have
   5 the same license.
   6
   7 ## Developer Certificate of Origin (DCO)
   8
   9 Before the ArmNN project accepts your contribution, you need to certify its origin and give us your permission.  To manage this process we use Developer Certificate of Origin (DCO) V1.1 (https://developercertificate.org/).
  10
  11 To indicate that you agree to the the terms of the DCO, you "sign off" your contribution by adding a line with your name and e-mail address to every git commit message:
  12
  13 Signed-off-by: John Doe <john.doe@example.org>
  14
  15 You must use your real name, no pseudonyms or anonymous contributions are accepted.
  16
  17 ## Releases
  18
  19 Official ArmNN releases are published through the official [ArmNN Github repository](https://github.com/ARM-software/armnn).
  20
  21 ## Development repository
  22
  23 The ArmNN development repository is hosted on the [mlplatform.org git repository](https://git.mlplatform.org/ml/armnn.git/) hosted by [Linaro](https://www.linaro.org/).
  24
  25 ## Code reviews
  26
  27 Contributions must go through code review. Code reviews are performed through the [mlplatform.org Gerrit server](https://review.mlplatform.org). Contributors need to signup to this Gerrit server with their GitHub account
  28 credentials.
  29
  30 Only reviewed contributions can go to the master branch of ArmNN.
  31
  32 ## Continuous integration
  33
  34 Contributions to ArmNN go through testing at the Arm CI system. All unit, integration and regression
  35 tests must pass before a contribution gets merged to the ArmNN master branch.
  36
  37 ## Communications
  38
  39 We encourage all ArmNN developer to subscribe to the [ArmNN developer mailing list](https://lists.linaro.org/mailman/listinfo/armnn-dev).