8000 Update the quick start. by ezio-melotti · Pull Request #115 · python/devguide · GitHub
[go: up one dir, main page]
Skip to content

Update the quick start. #115

8000
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
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
Next Next commit
Update the quick start.
  • Loading branch information
@ezio-melotti
ezio-melotti committed Feb 15, 2017
commit c5338020b3313e2bfb3e282ab91de93590936d9b
52 changes: 25 additions & 27 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,26 @@ Quick Start
Here are the basic steps needed to get :ref:`set up <setup>` and contribute a
patch:

1. Set up and install dependencies.
1. Install and set up :ref:`Git <vcsetup>` and other dependencies
(see the :ref:`Get Setup <setup>` page for detailed information).

Install :ref:`Git <vcsetup>` and other dependencies.
2. Fork `the CPython repository on GitHub <cpython github>`_ and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...GitHub to your GitHub account and...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be clear enough, since immediately after it clones from the user account.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ezio-melotti For someone that has used git, your wording is fine. If someone new to git/GitHub is trying to help, they will often get confused about what is getting forked and cloned where. I know it seems trivial, but it really does help those who are still learning.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

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

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

Is this clear enough?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Thanks @ezio-melotti

:ref:`get the source code <checkout>` using::

The dependencies needed will depend on the platform you're on.
Go to :ref:`Get Setup <setup>` page for detailed information.
git clone https://github.com/<your_username>/cpython

2. :ref:`Get the source code <checkout>`::
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 <compiling>`.
There are different instructions for :ref:`UNIX <unix-compiling>`,
:ref:`Mac OS <MacOS>`, and :ref:`Windows <windows-compiling>`.

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 <compiling>`,
:ref:`how to build dependencies <build-dependencies>`, and the
plaform-specific pages for :ref:`UNIX <unix-compiling>`,
:ref:`Mac OS <MacOS>`, and :ref:`Windows <windows-compiling>`.

4. :doc:`Run the tests <runtests>`::

Expand All @@ -52,13 +43,19 @@ 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
require any issue to be created.
5. Create a new branch where to work on an issue with::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

5. Create new branch where your work for the issue will go:

     git checkout -b new_branch_name master

For example, use `git checkout -b fix_issue master` to create a new branch named `fix_issue`.

...create it on the ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

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

     git checkout -b fix-issue-12345 master

Is this OK?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really like this change 👍


git checkout -b new_branch_name 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.

6. Once you fixed the issue, run the tests, run ``make patchcheck``, and if
everything is ok, commit.

6. Make a :doc:`pull request <pullrequest>`.
Include ``bpo-NNNN`` in the pull request description, where ``NNNN`` is the
issue number from the `issue tracker`_. For example::
7. Push the branch on your fork and :doc:`create a pull request <pullrequest>`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...your fork on GitHub and...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

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 @@ -305,6 +302,7 @@ 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
0