From a69aa0b7f003fea3c4a95986a94456450dcbdaf8 Mon Sep 17 00:00:00 2001 From: Erwan Rouchet <rouchet@teklia.com> Date: Thu, 11 Apr 2024 14:55:00 +0200 Subject: [PATCH] Use forks in the contributing guidelines --- content/develop/contributing.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/content/develop/contributing.md b/content/develop/contributing.md index b25b243b..8d7607e8 100644 --- a/content/develop/contributing.md +++ b/content/develop/contributing.md @@ -72,7 +72,9 @@ Please avoid: ### Publish your work -You are allowed to push directly on Arkindex's repositories, except for the `master` branch. The goal is for your code to be merged into `master` once the following steps are completed: +External contributors cannot push directly on Arkindex's repositories. You will need to create a fork of the repository under your own namespace, then open a Merge Request on the original repository. To learn more, check out GitLab's [forking workflow documentation](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html). + +The goal is for your code to be merged into `master` once the following steps are completed: 1. unit tests are all OK, meaning that all jobs in the CI stage named `test` ended in success 2. formatting has been validated by a tool, meaning that all jobs in the CI stage named `checks` ended in success @@ -84,6 +86,7 @@ When pushing [your code from your local branch](https://docs.gitlab.com/ee/user/ Once your work is ready, configure your Merge Request as follows: +- Make sure you are requesting a merge to the `master` branch of the upstream repository, not of your own fork. - Assign yourself as the **Assignee**. - Assign [@erouchet](https://gitlab.teklia.com/erouchet) as the **Reviewer**: he will either review or re-assign to another reviewer when needed. - Set an explicit name, in English, properly formatted. -- GitLab