summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Lord <davidism@gmail.com>2021-08-10 06:36:29 -0700
committerDavid Lord <davidism@gmail.com>2021-08-10 06:36:29 -0700
commitb10f4af1400f4b5d22a6d83633e35d500ade31da (patch)
treec4d90247635822179cf80c525eb2fdd286c5bf18
parent259d77e03d3e39526bcc91a6b44d4e5cd58ec7f0 (diff)
parentac0225fa921ea252fdee7f10c6d07fb0f8a94911 (diff)
downloaditsdangerous-b10f4af1400f4b5d22a6d83633e35d500ade31da.tar.gz
Merge remote-tracking branch 'origin/2.0.x'
-rw-r--r--CONTRIBUTING.rst12
-rw-r--r--README.rst2
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.
diff --git a/README.rst b/README.rst
index d4aefc2..9c37a82 100644
--- a/README.rst
+++ b/README.rst
@@ -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