8000 DOC: reorganize and simplify contributing.rst by tacaswell · Pull Request #7699 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: reorganize and simplify contributing.rst #7699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 5, 2017
Merged

DOC: reorganize and simplify contributing.rst #7699

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fc5dcf4
DOC: reorganize and simplify contributing.rst
tacaswell Dec 29, 2016
600544c
DOC: ensure local variables are defined
tacaswell Dec 31, 2016
de50bfa
DOC: bit more accurate how develop mode works
tacaswell Dec 31, 2016
03111bf
DOC: standardize on Matplotlib
tacaswell Dec 31, 2016
534b832
DOC: minor tweaks to wording + capitalization
tacaswell Jan 5, 2017
39f8798
DOC: fix typo
tacaswell Jan 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file 8000
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC: standardize on Matplotlib
  • Loading branch information
@tacaswell
tacaswell committed Dec 31, 2016
commit 03111bf5381812200efd16c9519372de77e50253
20 changes: 10 additions & 10 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ recommended.

.. warning::

If you already have a version of matplotlib installed, you will need to
If you already have a version of Matplotlib installed, you will need to
uninstall it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only in the same venv, I think? AFAICT that looks big and scary while it is simply not true if the instructions above are followed :-)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can drive your self to very strange situations with overlapping installs, but will re-word this to be a bit less scary.


We use `Git <https://git-scm.com/>`_ for version control and
Expand All @@ -40,7 +40,7 @@ You can check out the latest sources with the command (see

git clone git@github.com:matplotlib/matplotlib.git

and navigate to the matplotlib directory.
and navigate to the Matplotlib directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matplotlib -> matplotlib since you're talking about the directory.


To make sure the tests run locally you must build against the correct version
of freetype. To configure the build system to fetch and build it either export
Expand Down Expand Up @@ -105,7 +105,7 @@ Contributing code
How to contribute
-----------------

The preferred way to contribute to matplotlib is to fork the `main
The preferred way to contribute to Matplotlib is to fork the `main
repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
then submit a "pull request" (PR):

Expand Down Expand Up @@ -138,7 +138,7 @@ then submit a "pull request" (PR):

$ git push -u origin my-feature

Finally, go to the web page of your fork of the matplotlib repo,
Finally, go to the web page of your fork of the Matplotlib repo,
and click 'Pull request' to send your changes to the maintainers for review.
You may want to consider sending an email to the mailing list for more
visibility.
Expand Down Expand Up @@ -214,7 +214,7 @@ tools:

.. note::

The current state of the matplotlib code base is not compliant with all
The current state of the Matplotlib code base is not compliant with all
of those guidelines, but we expect that enforcing those constraints on all
new contributions will move the overall code base quality in the right
direction.
Expand All @@ -237,7 +237,7 @@ New contributors should look for the following tags when looking for issues.
We strongly recommend that new contributors tackle
`new-contributor-friendly <https://github.com/matplotlib/matplotlib/labels/new-contributor-friendly>`_
issues (easy, well documented issues, that do not require an understanding of
the different submodules of matplotlib) and
the different submodules of Matplotlib) and
`Easy-fix <https://github.com/matplotlib/matplotlib/labels/Difficulty%3A%20Easy>`_
issues. This helps the contributor become familiar with the contribution
workflow, and for the core devs to become acquainted with the contributor;
Expand All @@ -249,7 +249,7 @@ Other ways to contribute
=========================


Code is not the only way to contribute to matplotlib. For instance,
Code is not the only way to contribute to Matplotlib. For instance,
documentation is also a very important part of the project and often doesn't
get as much attention as it deserves. If you find a typo in the documentation,
or have made improvements, do not hesitate to send an email to the mailing
Expand Down Expand Up @@ -379,10 +379,10 @@ Developing a new backend
If you are working on a custom backend, the *backend* setting in
:file:`matplotlibrc` (:ref:`customizing-matplotlib`) supports an
external backend via the ``module`` directive. if
:file:`my_backend.py` is a matplotlib backend in your
:file:`my_backend.py` is a Matplotlib backend in your
:envvar:`PYTHONPATH`, you can set it on one of several ways

* in matplotlibrc::
* in :file:`matplotlibrc`::

backend : module://my_backend

Expand Down Expand Up @@ -413,7 +413,7 @@ when the website is built to show up both in the `examples
<../gallery.html>`_ sections of the website.

Any sample data that the example uses should be kept small and
distributed with matplotlib in the
distributed with Matplotlib in the
`lib/matplotlib/mpl-data/sample_data/` directory. Then in your
example code you can load it into a file handle with::

Expand Down
0