From d489eb2c4ced23a4b0bf8f0d5d08e54edea7fb1c Mon Sep 17 00:00:00 2001 From: Romain Dorgueil Date: Thu, 25 May 2017 15:44:18 +0200 Subject: [PATCH] [docs] tldr on how to create a feature branch and pull request it. --- docs/contribute/index.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst index 3c3f6e9..690cab7 100644 --- a/docs/contribute/index.rst +++ b/docs/contribute/index.rst @@ -13,6 +13,26 @@ contributions have less value, all contributions are very important. * You can enhance tests. * etc. +tl;dr +::::: + +1. Fork the github repository + +.. code-block:: shell-session + + $ git clone https://github.com/python-bonobo/bonobo.git # change this to use your fork. + $ cd bonobo + $ git remote add upstream https://github.com/python-bonobo/bonobo.git + $ git fetch upstream + $ git checkout upstream/develop -b feature/my_awesome_feature + $ # code, code, code, test, doc, code, test ... + $ git commit -m '[topic] .... blaaaah ....' + $ git push origin feature/my_awesome_feature + +2. Open pull request +3. Rince, repeat + + Code-related contributions (including tests and examples) :::::::::::::::::::::::::::::::::::::::::::::::::::::::::