From 1cbabf0aa6e57c363ad5fa40bc00d3f12485710d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Filip=20=C5=81apkiewicz?= <80906036+fipachu@users.noreply.github.com> Date: Tue, 17 Oct 2023 11:50:55 +0200 Subject: [PATCH 1/2] Update index.rst --- index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.rst b/index.rst index c4450e1e0..00069b088 100644 --- a/index.rst +++ b/index.rst @@ -58,7 +58,7 @@ instructions please see the :ref:`setup guide `. not require any issue to be created. 6. Once you fixed the issue, run the tests, run ``make patchcheck``, and if - everything is ok, commit. + everything is ok, commit. On windows run ``.\python.bat Tools\patchcheck\patchcheck.py`` 7. Push the branch on your fork on GitHub and :ref:`create a pull request `. Include the issue number using ``gh-NNNN`` in the From 885cdffe9f2a2e6ec0b5b6c9e3b7113784f7b4a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Filip=20=C5=81apkiewicz?= <80906036+fipachu@users.noreply.github.com> Date: Thu, 19 Oct 2023 16:44:59 +0200 Subject: [PATCH 2/2] Put OS specific instructions on their own lines --- index.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/index.rst b/index.rst index 00069b088..6c54779d7 100644 --- a/index.rst +++ b/index.rst @@ -57,8 +57,19 @@ instructions please see the :ref:`setup guide `. `_. Trivial issues (e.g. typo fixes) do not require any issue to be created. -6. Once you fixed the issue, run the tests, run ``make patchcheck``, and if - everything is ok, commit. On windows run ``.\python.bat Tools\patchcheck\patchcheck.py`` +6. Once you fixed the issue, run the tests, and the patchcheck. + + On Unix and macOS use:: + + make patchcheck + + and on Windows: + + .. code-block:: dosbatch + + .\python.bat Tools\patchcheck\patchcheck.py + + If everything is ok, commit. 7. Push the branch on your fork on GitHub and :ref:`create a pull request `. Include the issue number using ``gh-NNNN`` in the