aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicola Mazzucato <nicola.mazzucato@arm.com>2023-12-18 14:58:48 +0000
committerGirish Pathak <girish.pathak@arm.com>2024-01-11 14:15:31 +0000
commit38e6e4d4356dc4a573951a996dfb3df5a51135fe (patch)
tree23096e52c75cdab921792a41627f2b14336219c6
parentceaa1ec2b31b03a332781861ea54148c31a919d8 (diff)
scp: Update repo references to Gitlab
SCP-firmware repository has moved from GitHub to Gitlab (the Github instance is not accepting pull requests any longer). Update URLs in the contributing and user_guide to point to the active Gitlab repository. Simplify descriptions at the same time for submitting changes. Signed-off-by: Nicola Mazzucato <nicola.mazzucato@arm.com> Change-Id: I1417b4172c54ef0b4d40644416bd9e6995ee3079
-rw-r--r--contributing.md60
-rw-r--r--user_guide.md4
2 files changed, 28 insertions, 36 deletions
diff --git a/contributing.md b/contributing.md
index edf2c5887a0c..4365822129bc 100644
--- a/contributing.md
+++ b/contributing.md
@@ -4,12 +4,10 @@ Contributing to SCP-firmware
Getting Started
---------------
-- Make sure you have a [GitHub account](https://github.com/signup/free).
-- [Fork](https://help.github.com/articles/fork-a-repo)
- [SCP-firmware](https://github.com/ARM-software/SCP-firmware) on Github.
-- Clone the fork to your own machine.
+- Make sure you have a [Gitlab account](https://gitlab.com/users/sign_in).
+- Clone the repo to your own machine.
- Create a local topic branch based on the
- [SCP-firmware](https://github.com/ARM-software/SCP-firmware) `master` branch.
+ [SCP-firmware](https://gitlab.arm.com/firmware/SCP-firmware) `main` branch.
Making Changes
--------------
@@ -48,36 +46,30 @@ Submitting Changes
they must also add their own `Signed-off-by:` line. By adding this line the
contributor certifies the contribution is made under the terms of the
[Developer Certificate of Origin (DCO)](./dco.txt).
-- Push your local changes to your fork of the repository.
-- Submit a [pull request](https://help.github.com/articles/using-pull-requests)
- to the [SCP-firmware](https://github.com/ARM-software/SCP-firmware) `master`
+- Push your local changes to a new branch in the repository.
+- Submit a [merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+ to the [SCP-firmware](https://gitlab.arm.com/firmware/SCP-firmware) `main`
branch.
- - The changes in the
- [pull request](https://help.github.com/articles/using-pull-requests) will
- then undergo further review and testing by the
- [maintainers](./maintainers.md). Any review comments will be made as
- comments on the [pull request](https://help.github.com/articles/using-pull-requests).
+ - The changes in the merge request (MR) will then undergo further review and
+ testing by the maintainers. Any review comments will be made as
+ comments on the MR.
This may require you to do some rework.
-- When the changes are accepted, the [maintainers](./maintainers.md) will
- integrate them.
-
- - Typically, the [maintainers](./maintainers.md) will merge the
- [pull request](https://help.github.com/articles/using-pull-requests) into
- the 'master' branch within the Github UI by rebasing and then merging.
- - Please avoid creating merge commits in the
- [pull request](https://help.github.com/articles/using-pull-requests)
- itself.
- - If the [pull request](https://help.github.com/articles/using-pull-requests)
- is not based on a recent commit, the [maintainers](./maintainers.md) may
- rebase it onto the `master` branch first, or ask you to do this.
- - If the [pull request](https://help.github.com/articles/using-pull-requests)
- cannot be automatically merged, the [maintainers](./maintainers.md) will
- ask you to rebase it onto the `master` branch.
- - If after merging the [maintainers](./maintainers.md) find any issues, they
- may remove the commits and ask you to create a new pull request to resolve
- the problem.
- - Please do not delete your topic branch until it is safely merged into
- the `master` branch.
+ - When the changes are accepted, the maintainers will
+ integrate them.
+ - Typically, the maintainers will merge (fast-forward) the MR into the
+ `main` branch within the Gitlab UI by rebasing and then merging.
+ - Please avoid creating merge commits in the MR itself.
+ - If the MR is not based on a recent commit, the maintainers may rebase it
+ onto the `main` branch first, or ask you to do this.
+ - If the MR cannot be automatically merged, the maintainers will ask you
+ to rebase it onto the `main` branch.
+ - If after merging the maintainers find any issues, they may remove the
+ commits and ask you to create a new merge request to
+ resolve the problems.
+ - Please do not delete your topic branch until it is safely merged into
+ the `main` branch.
+ - The maintainers may also remove the original branch after the MR. If you
+ wish this not ot happen, please let the maintainers know in advance.
Followthrough
-------------
@@ -85,7 +77,7 @@ Followthrough
- From time to time new features may be added and older features/functionality
may deprecated. Code owners would be required to modify their code to support
such new requirements within a reasonable time. Failure to do so may result
-in the code being deprecated and no longer maintained as a part of the master
+in the code being deprecated and no longer maintained as a part of the `main`
branch.
- Any regressions must be fixed as soon as possible. If you are unwilling or
diff --git a/user_guide.md b/user_guide.md
index b0c859890f8e..3c5e36969cd6 100644
--- a/user_guide.md
+++ b/user_guide.md
@@ -119,10 +119,10 @@ sudo apt-get install pep8
## Cloning the SCP-firmware source code
-The SCP-firmware source code can be cloned from the official GitHub repository:
+The SCP-firmware source code can be cloned from the official Gitlab repository:
```sh
-git clone --recurse-submodules https://github.com/ARM-software/SCP-firmware.git\
+git clone --recurse-submodules https://git.gitlab.arm.com/firmware/SCP-firmware.git\
${SCP_PATH}
```