diff --git a/index.rst b/index.rst index f011627a6a..54c1fc983b 100644 --- a/index.rst +++ b/index.rst @@ -14,35 +14,26 @@ Quick Start Here are the basic steps needed to get :ref:`set up ` and contribute a patch: -1. Set up and install dependencies. +1. Install and set up :ref:`Git ` and other dependencies + (see the :ref:`Get Setup ` page for detailed information). - Install :ref:`Git ` and other dependencies. +2. Fork `the CPython repository `_ + to your GitHub account and :ref:`get the source code ` using:: - The dependencies needed will depend on the platform you're on. - Go to :ref:`Get Setup ` page for detailed information. + git clone https://github.com//cpython -2. :ref:`Get the source code `:: +3. Build Python, on UNIX and Mac OS use:: - git clone https://github.com/python/cpython + ./configure --with-pydebug && make -j -3. Build Python. - - Detailed information can be found :ref:`here `. - There are different instructions for :ref:`UNIX `, - :ref:`Mac OS `, and :ref:`Windows `. - - The command to compile on UNIX and Mac OS is:: - - ./configure --with-pydebug - make -j - - On Windows:: + and on Windows use:: PCbuild\build.bat -e -d - If the build outputs warnings or errors, :ref:`build-dependencies` provides - detail on standard library extensions that depend on installing third-party - libraries for some operating systems. + See also :ref:`more detailed instructions `, + :ref:`how to build dependencies `, and the + plaform-specific pages for :ref:`UNIX `, + :ref:`Mac OS `, and :ref:`Windows `. 4. :doc:`Run the tests `:: @@ -52,13 +43,20 @@ patch: with :file:`./python.exe`. On Windows, use :file:`python.bat`. With Python 2.7, replace ``test`` with ``test.regrtest``. -5. Work on an issue from the `issue tracker`_. If an issue does not already - exist, please create it. Trivial issues, like small typo fixes, do not +5. Create a new branch where your work for the issue will go, e.g.:: + + git checkout -b fix-issue-12345 master + + If an issue does not already exist, please `create it + `_. Trivial issues (e.g. typo fixes) do not require any issue to be created. -6. Make a :doc:`pull request `. - Include ``bpo-NNNN`` in the pull request description, where ``NNNN`` is the - issue number from the `issue tracker`_. For example:: +6. Once you fixed the issue, run the tests, run ``make patchcheck``, and if + everything is ok, commit. + +7. Push the branch on your fork on GitHub and :doc:`create a pull request + `. Include the issue number using ``bpo-NNNN`` in the + pull request description. For example:: bpo-12345: Fix some bug in spam module