aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Beck <david.beck@arm.com>2018-11-20 13:57:09 +0000
committerDavid Beck <david.beck@arm.com>2018-11-20 15:46:16 +0000
commit97f71306bdfdadb7ff7a55043ebce40f6c280223 (patch)
tree3bd6162f40cd03a26538d001e371df27e614356e
parent8910528b126fed87628c23f7e51f7e018b13989a (diff)
downloadarmnn-97f71306bdfdadb7ff7a55043ebce40f6c280223.tar.gz
IVGCVSW-2179 : ArmNN Contirbutor Guide
Change-Id: I4887e3509a7f406c80f7eb55c04bdf62395c6cf6
-rw-r--r--ContributorGuide.md29
-rw-r--r--README.md7
2 files changed, 35 insertions, 1 deletions
diff --git a/ContributorGuide.md b/ContributorGuide.md
new file mode 100644
index 0000000000..382b719259
--- /dev/null
+++ b/ContributorGuide.md
@@ -0,0 +1,29 @@
+# Contributor Guide
+
+The ArmNN project is open for external contributors and welcomes contributions. ArmNN is licensed
+under the [MIT license](https://spdx.org/licenses/MIT.html) and all accepted contributions must have
+the same license.
+
+## Releases
+
+Official ArmNN releases are published through the official [ArmNN Github repository](https://github.com/ARM-software/armnn).
+
+## Development repository
+
+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/).
+
+## Code reviews
+
+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
+credentials.
+
+Only reviewed contributions can go to the master branch of ArmNN.
+
+## Continuous integration
+
+Contributions to ArmNN go through testing at the Arm CI system. All unit, integration and regression
+tests must pass before a contribution gets merged to the ArmNN master branch.
+
+## Communications
+
+We encourage all ArmNN developer to subscribe to the [ArmNN developer mailing list](https://lists.linaro.org/mailman/listinfo/armnn-dev).
diff --git a/README.md b/README.md
index ebe113ca06..41172e0e2b 100644
--- a/README.md
+++ b/README.md
@@ -39,4 +39,9 @@ Individual files contain the following tag instead of the full license text.
SPDX-License-Identifier: MIT
-This enables machine processing of license information based on the SPDX License Identifiers that are available here: http://spdx.org/licenses/ \ No newline at end of file
+This enables machine processing of license information based on the SPDX License Identifiers that are available here: http://spdx.org/licenses/
+
+### Contributions
+
+The ArmNN project welcomes contributions. Please see the [Contributor Guide](ContributorGuide.md) for
+more details.