Skip to content

Update the quick start. #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willingc merged 2 commits into from
Feb 15, 2017
Merged

Update the quick start. #115

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c533802
Update the quick start.
ezio-melotti Feb 15, 2017
d141c8e
Address review comments and fix two external links.
ezio-melotti Feb 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Address review comments and fix two external links.
  • Loading branch information
@ezio-melotti
ezio-melotti committed Feb 15, 2017
commit d141c8e74de20951f17522fdc679a7fc1e5a02bf
20 changes: 10 additions & 10 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ patch:
1. Install and set up :ref:`Git <vcsetup>` and other dependencies
(see the :ref:`Get Setup <setup>` page for detailed information).

2. Fork `the CPython repository on GitHub <cpython github>`_ and
:ref:`get the source code <checkout>` using::
2. Fork `the CPython repository <https://github.com/python/cpython>`_
to your GitHub account and :ref:`get the source code <checkout>` using::

git clone https://github.com/<your_username>/cpython

Expand All @@ -43,19 +43,20 @@ patch:
with :file:`./python.exe`. On Windows, use :file:`python.bat`. With Python
2.7, replace ``test`` with ``test.regrtest``.

5. Create a new branch where to work on an issue with::
5. Create a new branch where your work for the issue will go, e.g.::

git checkout -b new_branch_name master
git checkout -b fix-issue-12345 master

If an issue does not already exist, please `create it <issue tracker>`_.
Trivial issues (e.g. typo fixes) do not require any issue to be created.
If an issue does not already exist, please `create it
<https://bugs.python.org/>`_. 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.

7. Push the branch on your fork and :doc:`create a pull request <pullrequest>`.
Include the issue number using ``bpo-NNNN`` in the pull request description.
For example::
7. Push the branch on your fork on GitHub and :doc:`create a pull request
<pullrequest>`. Include the issue number using ``bpo-NNNN`` in the
pull request description. For example::

bpo-12345: Fix some bug in spam module

Expand Down Expand Up @@ -302,7 +303,6 @@ Full Table of Contents

.. _Buildbot status: https://www.python.org/dev/buildbot/
.. _Firefox search engine plug-in: https://www.python.org/dev/searchplugin/
.. _cpython github: https://github.com/python/cpython
.. _Misc directory: https://github.com/python/cpython/tree/master/Misc
.. _PEPs: https://www.python.org/dev/peps/
.. _python.org maintenance: https://pythondotorg.readthedocs.io/
Expand Down