summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Lord <davidism@gmail.com>2021-05-25 06:43:49 -0700
committerGitHub <noreply@github.com>2021-05-25 06:43:49 -0700
commita4a6f8b41bfb1b18302148cbbf6a6af781868cd8 (patch)
tree95028a7d90a59cc7cc25329485617794a9abb386
parenta5d7d71ba0c5f32eea31a49bcc1d004c272b60e5 (diff)
parent123a84531d48bb4e80f46868aacb6401243900aa (diff)
downloadmarkupsafe-a4a6f8b41bfb1b18302148cbbf6a6af781868cd8.tar.gz
Merge pull request #220 from greyli/improve-contributing-guide
Improve the contributing guide
-rw-r--r--CONTRIBUTING.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index c58ad8c..5c999c6 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -92,7 +92,7 @@ First time setup
.. code-block:: text
- git remote add fork https://github.com/{username}/markupsafe
+ $ git remote add fork https://github.com/{username}/markupsafe
- Create a virtualenv.
@@ -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 MarkupSafe in
editable mode.
@@ -138,7 +144,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.