Skip to content

Commit

Permalink
Improve the contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
greyli committed May 25, 2021
1 parent f0bf725 commit 8e9f4ee
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ First time setup

.. code-block:: text
git remote add fork https://github.com/{username}/click
$ git remote add fork https://github.com/{username}/click
- Create a virtualenv.

Expand All @@ -107,6 +107,12 @@ First time setup
> env\Scripts\activate
- Upgrade pip and setuptools.

.. code-block:: text
$ python -m pip install --upgrade pip setuptools
- Install the development dependencies, then install Click in
editable mode.

Expand All @@ -124,7 +130,7 @@ First time setup
.. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git
.. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address
.. _GitHub account: https://github.com/join
.. _Fork: https://github.com/pallets/jinja/fork
.. _Fork: https://github.com/pallets/click/fork
.. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork


Expand All @@ -138,7 +144,7 @@ Start coding
.. code-block:: text
$ git fetch origin
$ git checkout -b your-branch-name origin/7.x
$ git checkout -b your-branch-name origin/8.0.x
If you're submitting a feature addition or change, branch off of the
"main" branch.
Expand Down

0 comments on commit 8e9f4ee

Please sign in to comment.