Update the quick start. #115
Conversation
index.rst
Outdated
|
|
||
| Install :ref:`Git <vcsetup>` and other dependencies. | ||
| 2. Fork `the CPython repository on GitHub <cpython github>`_ and |
There was a problem hiding this comment.
...GitHub to your GitHub account and...
There was a problem hiding this comment.
This should be clear enough, since immediately after it clones from the user account.
There was a problem hiding this comment.
@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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Looks great. Thanks @ezio-melotti
index.rst
Outdated
| 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:: |
There was a problem hiding this comment.
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 ...
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Really like this change 👍
index.rst
Outdated
| 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>`. |
There was a problem hiding this comment.
...your fork on GitHub and...
There was a problem hiding this comment.
Thanks @ezio-melotti. A few small clarifications for new contributors.
|
Thank you @ezio-melotti 🍪 |
|
This looks great! Thank you @ezio-melotti 🎉 |
* Update the quick start. * Address review comments and fix two external links.
I updated the quick start, trying to making it more compact and clarifying a few points (e.g. users should clone the repo from their own account, not from python/cpython).