Skip to content

Commit 24638b1

Browse files
committed
docs: Update documentation for the migration to GitHub
Partially-resolves: COMPMID-8450 Signed-off-by: Andreas Flöjt <[email protected]> Change-Id: I963c046e0a277ac2d7551e5146a21f0732f6f432
1 parent 4dfa9fe commit 24638b1

File tree

4 files changed

+12
-50
lines changed

4 files changed

+12
-50
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1 @@
1-
Please read https://artificial-intelligence.sites.arm.com/computelibrary/latest/contribution_guidelines.xhtml
2-
3-
Here on github we only publish a snapshot of the main development branch for each release, that's the reason why we don't accept pull requests.
4-
5-
Please submit your patch for review to review.mlplatform.org.
6-
7-
The development is structured in the following way:
8-
9-
Release repository: https://github.com/arm-software/ComputeLibrary
10-
Development repository: https://review.mlplatform.org/#/admin/projects/ml/ComputeLibrary
11-
Please report issues here: https://github.com/ARM-software/ComputeLibrary/issues
1+
Please read https://artificial-intelligence.sites.arm.com/computelibrary/latest/contribution_guidelines.xhtml.

README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,6 @@ Key Features:
3131
- Advanced optimization techniques such as kernel fusion, Fast math enablement and texture utilization
3232
- Device and workload specific tuning using OpenCL tuner and GeMM optimized heuristics
3333

34-
<br>
35-
36-
| Repository | Link |
37-
| ----------- | ---------------------------------------------------------------- |
38-
| Release | https://github.com/arm-software/ComputeLibrary |
39-
| Development | https://review.mlplatform.org/#/admin/projects/ml/ComputeLibrary |
40-
41-
<br>
42-
4334
## Documentation
4435
[![Documentation](https://img.shields.io/badge/documentation-latest-green)](https://artificial-intelligence.sites.arm.com/computelibrary/latest/index.xhtml)
4536

REUSE.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ SPDX-License-Identifier = "MIT"
4848

4949
[[annotations]]
5050
path = ["CONTRIBUTING.md"]
51-
SPDX-FileCopyrightText = "2022-2024 Arm Limited"
51+
SPDX-FileCopyrightText = "2022-2025 Arm Limited"
5252
SPDX-License-Identifier = "MIT"
5353

5454
[[annotations]]

docs/contributor_guide/contribution_guidelines.dox

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
///
2-
/// Copyright (c) 2019-2023 Arm Limited.
2+
/// Copyright (c) 2019-2023, 2025 Arm Limited.
33
///
44
/// SPDX-License-Identifier: MIT
55
///
@@ -30,10 +30,7 @@ namespace arm_compute
3030

3131
If you want to contribute to Arm Compute Library, be sure to review the following guidelines.
3232

33-
The development is structured in the following way:
34-
- Release repository: https://github.com/arm-software/ComputeLibrary
35-
- Development repository: https://review.mlplatform.org/#/admin/projects/ml/ComputeLibrary
36-
- Please report issues here: https://github.com/ARM-software/ComputeLibrary/issues
33+
Contributions are accepted at <a href="https://github.com/arm-software/ComputeLibrary">arm-software/ComputeLibrary</a>.
3734

3835
@section S5_0_inc_lang Inclusive language guideline
3936
As part of the initiative to use inclusive language, there are certain phrases and words that were removed or replaced by more inclusive ones. Examples include but not limited to:
@@ -481,22 +478,9 @@ void DoNewThing();
481478

482479
@section S5_2_how_to_submit_a_patch How to submit a patch
483480

484-
To be able to submit a patch to our development repository you need to have a GitHub account. With that, you will be able to sign in to Gerrit where your patch will be reviewed.
485-
486-
Next step is to clone the Compute Library repository:
487-
488-
git clone "ssh://<your-github-id>@review.mlplatform.org:29418/ml/ComputeLibrary"
489-
490-
If you have cloned from GitHub or through HTTP, make sure you add a new git remote using SSH:
491-
492-
git remote add acl-gerrit "ssh://<your-github-id>@review.mlplatform.org:29418/ml/ComputeLibrary"
493-
494-
After that, you will need to upload an SSH key to https://review.mlplatform.org/#/settings/ssh-keys
495-
496-
Then, make sure to install the commit-msg Git hook in order to add a change-ID to the commit message of your patch:
497-
498-
cd "ComputeLibrary" && mkdir -p .git/hooks && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://review.mlplatform.org/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)
481+
To be able to submit a patch to our development repository you need to raise a pull request on GitHub.
499482

483+
Keep your patch in a single commit, with a message that adheres to <a href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a>.
500484
When your patch is ready, remember to sign off your contribution by adding a line with your name and e-mail address to every git commit message:
501485

502486
Signed-off-by: John Doe <[email protected]>
@@ -507,22 +491,19 @@ You can add this to your patch with:
507491

508492
git commit -s --amend
509493

510-
You are now ready to submit your patch for review:
511-
512-
git push acl-gerrit HEAD:refs/for/main
494+
You are now ready to submit your patch for review in a pull request.
513495

514496
@section S5_3_code_review Patch acceptance and code review
515497

516-
Once a patch is uploaded for review, there is a pre-commit test that runs on a Jenkins server for continuous integration tests. In order to be merged a patch needs to:
498+
Once a patch is uploaded for review, there is a pre-commit test that runs on a Jenkins server for continuous integration tests.
499+
In order to be merged, a patch needs to:
517500

518-
- get a "+1 Verified" from the pre-commit job
519-
- get a "+1 Comments-Addressed", in case of comments from reviewers the committer has to address them all. A comment is considered addressed when the first line of the reply contains the word "Done"
520-
- get a "+2" from a reviewer, that means the patch has the final approval
501+
- pass the pre-commit job,
502+
- be squashed,
503+
- be approved by a Compute Library maintainer.
521504

522505
At the moment, the Jenkins server is not publicly accessible and for security reasons patches submitted by non-allowlisted committers do not trigger the pre-commit tests. For this reason, one of the maintainers has to manually trigger the job.
523506

524-
If the pre-commit test fails, the Jenkins job will post a comment on Gerrit with the details about the failure so that the committer will be able to reproduce the error and fix the issue, if any (sometimes there can be infrastructure issues, a test platform disconnecting for example, where the job needs to be retriggered).
525-
526507
@section S5_4_patch_reversion Patch reversion policy
527508

528509
If the contributed patch breaks our regression suite, we either

0 commit comments

Comments
 (0)