diff options
-rw-r--r-- | CONTRIBUTING.rst | 12 | ||||
-rw-r--r-- | README.rst | 2 |
2 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1864356..ac319c1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -93,7 +93,7 @@ First time setup .. code-block:: text - git remote add fork https://github.com/{username}/itsdangerous + $ git remote add fork https://github.com/{username}/itsdangerous - Create a virtualenv. @@ -108,6 +108,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 ItsDangerous in editable mode. @@ -125,7 +131,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/itsdangerous/fork .. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-a-local-clone-of-your-fork @@ -139,7 +145,7 @@ Start coding .. code-block:: text $ git fetch origin - $ git checkout -b your-branch-name origin/1.0.x + $ git checkout -b your-branch-name origin/2.0.x If you're submitting a feature addition or change, branch off of the "main" branch. @@ -21,7 +21,7 @@ Install and update using `pip`_: pip install -U itsdangerous -.. _pip: https://pip.pypa.io/en/stable/quickstart/ +.. _pip: https://pip.pypa.io/en/stable/getting-started/ A Simple Example |