From 45d762b78981134db314fcb8062cad3dbac22634 Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Thu, 21 Mar 2019 19:08:53 +0100 Subject: [PATCH] README: Tell about opening issue to lock a file. --- README.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index f0f77a58..0a7603fd 100644 --- a/README.rst +++ b/README.rst @@ -80,15 +80,20 @@ is python 3.7, we don't want to translate directly on the python 3.5 release. If needed translations would be backported on the oldest versions by the `documentation team `. +First, you need to find a file to work on. You can use `potodo +`. Install it (``pip install +potodo`` in a venv) and then run the command `potodo` in your cloned +fork. From the list it spits out, you can choose any file that is not +reserved. We recommend not starting with a file from ``c-api` as it is +very technical. + +Once you've choosen a file, please open an issue telling you're +working on it, to block someone from working on it. + Now you're ready to start a work session, each time you'll start a new task, start here: .. code-block:: bash - # First, you need to find a file to work on. You can use `potodo `. - # Install it and then run the command `potodo` in your cloned fork. - # From the list it spits out, you can choose any file that is not reserved. We recommend not starting - # with a file from `c-api as` it is very technical. - # To work, we'll need a branch, based on an up-to-date (freshly fetched) # upstream/3.7 branch, let's say we'll work on glossary so we name # the branch "glossary":