From e575dd7576e8869bad2c14bb21902ffde3e630fd Mon Sep 17 00:00:00 2001
From: Fredrik Svedberg <fredrik.svedberg@arm.com>
Date: Mon, 13 Jan 2025 13:59:26 +0100
Subject: [PATCH] MLBEDSW-9879 Update contribution documentation

Updated contribution documentation with information about forks.

Change-Id: I47c03c03aa2bf90013705941b6342b9dbb6207ef
Signed-off-by: Fredrik Svedberg <fredrik.svedberg@arm.com>
---
 BUGS.md                             |  6 +++---
 CONTRIBUTIONS.md => CONTRIBUTING.md | 18 +++++++++++-------
 OPTIONS.md                          |  7 ++++---
 README.md                           |  4 ++--
 4 files changed, 20 insertions(+), 15 deletions(-)
 rename CONTRIBUTIONS.md => CONTRIBUTING.md (82%)

diff --git a/BUGS.md b/BUGS.md
index 00eac29d..0d61cc75 100644
--- a/BUGS.md
+++ b/BUGS.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Copyright 2021, 2023-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2021, 2023-2025 Arm Limited and/or its affiliates <open-source-office@arm.com>
 
 SPDX-License-Identifier: Apache-2.0
 
@@ -27,7 +27,7 @@ The only prerequisite for this process is a GitHub account, which will be used
 when creating an account on Arm's GitLab Instance.
 
 If you also have a fix for the bug you have identified, then we encourage
-you to follow the [contributions guide](CONTRIBUTIONS.md).
+you to follow the [contributions guide](CONTRIBUTING.md).
 
 The bug reporting process in its entirety is detailed below.
 
@@ -147,7 +147,7 @@ A confirmation e-mail will be sent out to the linked e-mail address.
 Any further changes to the report will be sent out in the same way.
 
 If you also have a fix for the issue being reported then please follow the
-[Vela Contributions Guide](CONTRIBUTIONS.md) to submit your patch. Also, please
+[Vela Contributions Guide](CONTRIBUTING.md) to submit your patch. Also, please
 include a link to your merge request in the issue description.
 
 ## Arm's [ML Model Review](https://www.arm.com/resources/contact-us/ml-model-review) process.
diff --git a/CONTRIBUTIONS.md b/CONTRIBUTING.md
similarity index 82%
rename from CONTRIBUTIONS.md
rename to CONTRIBUTING.md
index dbb7bd8f..d78c5228 100644
--- a/CONTRIBUTIONS.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Copyright 2020-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates <open-source-office@arm.com>
 
 SPDX-License-Identifier: Apache-2.0
 
@@ -27,13 +27,17 @@ formatting and linting tools described in [Vela Testing](TESTING.md)
 
 ## Submitting
 
-In order to submit a contribution push your patch to the
-[Vela GitLab project](https://gitlab.arm.com/artificial-intelligence/ethos-u/ethos-u-vela)
-using the address `git@git.gitlab.arm.com:artificial-intelligence/ethos-u/ethos-u-vela.git`.
+In order to submit a contribution to the
+[Vela GitLab project](https://gitlab.arm.com/artificial-intelligence/ethos-u/ethos-u-vela), 
+please read and follow the 
+[Arm GitLab contributions guide](https://gitlab.arm.com/documentation/contributions)
+on how to create a fork of the project.
 To do this you will need to sign-in to the platform using a GitHub account and
-add your SSH key under your settings. If there is a problem adding the SSH key make sure
-there is a valid email address in the Email Addresses field.  
-In the commit message please include a Signed-off-by (described below).
+add your SSH key under your settings.  If there is a problem adding the SSH key
+make sure there is a valid email address in the Email Addresses field.  
+In the commit message please include a Signed-off-by (described below).  
+When the merge request is created, make sure the target project is
+`artificial-intelligence/ethos-u/ethos-u-vela` and the target branch is `main`.
 
 
 ## Contribution Guidelines
diff --git a/OPTIONS.md b/OPTIONS.md
index 4d22564e..df28b006 100644
--- a/OPTIONS.md
+++ b/OPTIONS.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Copyright 2020-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates <open-source-office@arm.com>
 
 SPDX-License-Identifier: Apache-2.0
 
@@ -641,8 +641,9 @@ vela network.tflite --accelerator-config ethos-u55-256 --config Arm/vela.ini --s
 Hardware vendors and/or users may wish to contribute their own configuration
 files for various SoC platforms by adding a .ini file in an appropriate
 directory under the ethosu/config_files directory.  This can be done by
-following the process outlined in CONTRIBUTIONS.md. These can then be accessed
-with `--config <DirectoryName>/config.ini` as in the example above.
+following the process outlined in [CONTRIBUTING.md](CONTRIBUTING.md).  These can
+then be accessed with `--config <DirectoryName>/config.ini` as in the example
+above.
 
 To use configuration files located outside the config_files directory, provide
 its absolute path to `--config`. The `--list-config-files` option can be used to
diff --git a/README.md b/README.md
index 50a55089..46d2d14c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Copyright 2020-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>
+SPDX-FileCopyrightText: Copyright 2020-2025 Arm Limited and/or its affiliates <open-source-office@arm.com>
 
 SPDX-License-Identifier: Apache-2.0
 
@@ -343,7 +343,7 @@ report bugs.
 
 ## Contributions
 
-Please see [Vela Contributions](CONTRIBUTIONS.md).
+Please see [Vela Contributions](CONTRIBUTING.md).
 
 ## Debug Database
 
-- 
GitLab