Skip to content

Commit 297070a

Browse files
committed
add install step to the Contributing code
also remove the $ as they make it more difficult for readers to copy paste link to more detailed dev install instructions only link to install page in brief set up docs.
1 parent 7941c36 commit 297070a

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

doc/devel/contributing.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,27 +102,29 @@ A brief overview is:
102102

103103
3. Clone this copy to your local disk::
104104

105-
$ git clone https://github.com/YourLogin/matplotlib.git
105+
git clone https://github.com/<YOUR GITHUB USERNAME>/matplotlib.git
106106

107-
4. Create a branch to hold your changes::
107+
4. Enter the directory and install the local version of Matplotlib.
108+
See ref`<installing_for_devs>` for instructions
108109

109-
$ git checkout -b my-feature origin/master
110+
5. Create a branch to hold your changes::
111+
112+
git checkout -b my-feature origin/master
110113

111114
and start making changes. Never work in the ``master`` branch!
112115

113-
5. Work on this copy, on your computer, using Git to do the version control.
116+
6. Work on this copy, on your computer, using Git to do the version control.
114117
When you're done editing e.g., ``lib/matplotlib/collections.py``, do::
115118

116-
$ git add lib/matplotlib/collections.py
117-
$ git commit
119+
git add lib/matplotlib/collections.py
120+
git commit
118121

119122
to record your changes in Git, then push them to GitHub with::
120123

121-
$ git push -u origin my-feature
124+
git push -u origin my-feature
122125

123126
Finally, go to the web page of your fork of the Matplotlib repo, and click
124-
'Pull request' to send your changes to the maintainers for review. You may
125-
want to consider sending an email to the mailing list for more visibility.
127+
'Pull request' to send your changes to the maintainers for review.
126128

127129
.. seealso::
128130

0 commit comments

Comments
 (0)