aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTIONS.md
diff options
context:
space:
mode:
authorTim Hall <tim.hall@arm.com>2020-05-26 09:18:53 +0100
committerTim Hall <tim.hall@arm.com>2020-06-18 17:53:52 +0100
commitf1b67deadf80db5c7c65d5a31737e57047fff533 (patch)
tree5eb869300b1cc68b0cb6bdee27cb9a6c3063d452 /CONTRIBUTIONS.md
parent93dc553d206e795250e420676e4c46dd9269ad82 (diff)
downloadethos-u-vela-f1b67deadf80db5c7c65d5a31737e57047fff533.tar.gz
MLBEDSW-2063: Add contributions guidelines
- Create new CONTRIBUTIONS.md - Rearrange README.md to reference new documentation Signed-off-by: Tim Hall <tim.hall@arm.com> Change-Id: I502b1606a3fe829a9e242a5de7391bf769203b8c
Diffstat (limited to 'CONTRIBUTIONS.md')
-rw-r--r--CONTRIBUTIONS.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/CONTRIBUTIONS.md b/CONTRIBUTIONS.md
new file mode 100644
index 00000000..5bef60a9
--- /dev/null
+++ b/CONTRIBUTIONS.md
@@ -0,0 +1,37 @@
+# Vela Contributions
+
+Contributions to Vela are very much welcomed!
+
+## Coding Standard
+
+Vela requires Python 3.6 to run. However, it is written using only version 3.5
+language constructs with the addition of Enums (hence requiring 3.6 to run).
+The aim is to maintain this in order to aid compatibility with other tools.
+
+## Submitting
+
+In order to submit a contribution please submit a Change Request (CR) to the
+[Vela Gerrit Server](https://review.mlplatform.org/q/project:ml%252Fethos-u%252Fethos-u-vela).
+To do this you will need to sign-in to the platform using a GitHub account.
+
+## Contribution Guidelines
+
+Contributions are only accepted under the following conditions:
+
+* You certify that the origin of the submission conforms to the
+[Developer Certificate of Origin (DCO) V1.1](https://developercertificate.org/)
+* You give permission according to the [Apache License 2.0](LICENSE.txt).
+
+To indicate that you agree to the contribution guidelines you must add an
+appropriate 'Signed-off-by: Real Name username@example.org' line with your real
+name and e-mail address to every commit message. This can be done automatically
+by adding the `-s` option to your `git commit` command.
+
+No contributions will be accepted from pseudonyms or anonymous sources.
+
+## Code Reviews
+
+All contributions go through a code review process. Only submissions that are
+approved and verified by this process will be accepted. Code reviews are
+performed using the
+[Vela Gerrit Server](https://review.mlplatform.org/q/project:ml%252Fethos-u%252Fethos-u-vela).