From 44c2fede6e38dfd3aef29a53f7bdce816f8f7aea Mon Sep 17 00:00:00 2001
From: AGULLO Emmanuel <emmanuel.agullo@inria.fr>
Date: Fri, 12 Apr 2019 15:48:18 +0200
Subject: [PATCH 1/2] Add instructions for external contributors
---
CONTRIBUTING.org | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
index 18bab331a..b31fba05e 100644
--- a/CONTRIBUTING.org
+++ b/CONTRIBUTING.org
@@ -1,5 +1,6 @@
* To contribute to the project, you need to do it through merge request
-** Create a fork
+** Regular / Inria contributors
+*** Create a fork
First you need to fork the repository into your own account. You can
do that simply by clicking the fork button on the gitlab interface.
@@ -23,7 +24,7 @@
git push -u origin master
#+end_src
-** Create a "Feature" branch in your fork
+*** Create a "Feature" branch in your fork
To add a new feature, fix a bug, and so on, you need to create a
new branch from the last state of the master branch
@@ -38,7 +39,7 @@
git push origin your_branch_name
#+end_src
-** Merge request
+*** Merge request
Once your branch is online, on the gitlab interface, go to the
branches webpage, select the branch you want to push as a merge
request, and push the button !!!
@@ -52,7 +53,7 @@
please add "fix issue #xx" in the comment of the pull request to
automatically close the issue when the PR is merged.
-** Rebase on top of 'master'
+*** Rebase on top of 'master'
In some cases your "feature" branch you want to merge into "master"
has a long life span so that your branch and the master branch
could make some conflicts. To avoid having to handle the possible
@@ -72,6 +73,20 @@
Then push the button *merge request*.
+** Occasional / external contributors
+*** Create a gitlab account
+Whereas [[https://gitlab.inria.fr/solverstack/chameleon][Chameleon]] is a public project and does not require an authentication
+to access it, a gitlab account is necessary to contribute. If you do not
+already have one, this is the first step to do. Note that Inria members can
+login directly with their Inria login in the *iLDAP* tab of the [[https://gitlab.inria.fr/users/sign_in][sign_in]] page.
+External users need to first [[https://gitlab-account.inria.fr/][register]] and can then login in the *Standard*
+tab of the [[https://gitlab.inria.fr/users/sign_in][sign_in]] page.
+*** Post an issue
+Create a new issue (see [[https://gitlab.inria.fr/solverstack/chameleon/issues][issues]]) presenting your contribution proposal (feature,
+fix, ...). The Chameleon team will set up a contribution branch for you on which
+you will be able to push, and will provide you further instructions to share
+your contributions and perform your merge request.
+
* Configure a runner to test your branch
To be effectively merged, your branch must be tested through the
[[https://gitlab.inria.fr/help/ci/README.md][gitlab-ci]] mechanism.
--
GitLab
From 3e89d24ecf9440190b2d88affb33621f6723da66 Mon Sep 17 00:00:00 2001
From: AGULLO Emmanuel <emmanuel.agullo@inria.fr>
Date: Fri, 12 Apr 2019 16:45:29 +0200
Subject: [PATCH 2/2] Add suggestions from Mathieu.
---
CONTRIBUTING.org | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
index b31fba05e..68757f7c2 100644
--- a/CONTRIBUTING.org
+++ b/CONTRIBUTING.org
@@ -83,9 +83,10 @@ External users need to first [[https://gitlab-account.inria.fr/][register]] and
tab of the [[https://gitlab.inria.fr/users/sign_in][sign_in]] page.
*** Post an issue
Create a new issue (see [[https://gitlab.inria.fr/solverstack/chameleon/issues][issues]]) presenting your contribution proposal (feature,
-fix, ...). The Chameleon team will set up a contribution branch for you on which
-you will be able to push, and will provide you further instructions to share
-your contributions and perform your merge request.
+fix, ...). The Chameleon team will set up a contribution branch for you. You can
+attach a patch to the issue, which we will use in this case to initiate the
+branch. In any case, we will then provide you with further instructions to work
+on the branch and eventually perform your merge request.
* Configure a runner to test your branch
To be effectively merged, your branch must be tested through the
--
GitLab