From d9ef4ff63b24441c300ce0bb52d53e0d35dd38c6 Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Thu, 1 Feb 2018 14:47:25 +0100 Subject: [PATCH] Mention to assign issue / open MR asap --- CONTRIBUTING.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30d8475bcd..2641730607 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,24 @@ How to contribute ================= +Whenever you start working on a bug or an issue, please mention it in the +corresponding issue on this repo. If there is not an already opened issue for +this bug, please open a MR as soon as possible (with the `WIP:` prefix +mentionning it is a work in progress) to let others know you are working on +this module and fixing things. + +This way, everyone is aware of the changes you are making and this avoid doing +a lot of duplicate work. + + Write a patch ------------- Help yourself with the `documentation `_. -Find an opened issue on `this website `_, or write your own bugfix or feature. -Then, once it is necessary, commit with:: +Find an opened issue on `this website +`_, or write your own bugfix or +feature. Then, once it is necessary, commit with:: $ git commit -a @@ -30,9 +41,10 @@ Perhaps you should also write or fix tests. These tests are automatically run by Create a merge request or send a patch -------------------------------------- -The easiest way to send your patch is to create a fork on `the Weboob Gitlab `_ and create a merge -request from there. This way, the code review process is easier and continuous integration is run automatically (see -previous section). +The easiest way to send your patch is to create a fork on `the Weboob Gitlab +`_ and create a merge request from there. This way, +the code review process is easier and continuous integration is run +automatically (see previous section). If you prefer good old email patches, just use -- GitLab