From 39ac2dba3604a30388b393820906a64f6a9e4749 Mon Sep 17 00:00:00 2001 From: Matt Clarkson Date: Fri, 20 Sep 2024 16:19:18 +0100 Subject: [PATCH] docs(contributing): add workflow guide --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 112a2d80..c7ca75ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,13 @@ $ (cd e2e; bazelisk test //...) [bazelisk-install]: https://github.com/bazelbuild/bazelisk?tab=readme-ov-file#installation +# Workflow + +- Follow the [contributions guide] to be granted forking permissions. +- [Fork] the project +- Implement the change +- [Create merge request] from fork + # Release `semantic-release` performs automatic releases of the project. @@ -20,5 +27,7 @@ Release channels for `alpha`, `beta` and `stable` releases are used. The [upstream configuration usage guide][semrel-release-channels-usage] provides information on how to perform a release. -[semrel-release-channels-usage]: - https://gitlab.arm.com/semantic-release/config-release-channels/-/blob/main/README.md?ref_type=heads#usage +[semrel-release-channels-usage]: https://gitlab.arm.com/semantic-release/config-release-channels/-/blob/main/README.md?ref_type=heads#usage +[contributions guide]: https://gitlab.arm.com/documentation/contributions#contributions +[Fork]: https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#create-a-fork +[Create merge request]: https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#merge-changes-back-upstream -- GitLab