From 3a31d47c83fbe2fa383b70defd85d036910b9a02 Mon Sep 17 00:00:00 2001 From: Haibo Lin Date: Fri, 7 Feb 2020 17:00:39 +0800 Subject: [PATCH] doc: add code convention requirements JIRA: COMPOSE-4108 Signed-off-by: Haibo Lin --- doc/contributing.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/contributing.rst b/doc/contributing.rst index fb8217f2..ca547df0 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -99,6 +99,8 @@ Currently the development workflow for Pungi is on master branch: git checkout my_topic_branch # make changes to setup.py + black setup.py + tox git add setup.py git commit -s -m "added awesome feature to setup.py" @@ -115,8 +117,11 @@ Currently the development workflow for Pungi is on master branch: git push origin my_topic_branch .. note:: - In order to for your commit to be merged, you must sign-off on it. Use - ``-s`` option when running ``git commit``. + In order to for your commit to be merged: + + - you must sign-off on it. Use ``-s`` option when running ``git commit``. + + - The code must be well formatted via ``black`` and pass ``flake8`` checking. Run ``tox`` to do the check. - Create pull request in the pagure.io web UI