Skip to content

Commit b274f78

Browse files
tacaswelltacaswell
authored
Merge pull request #26270 from QuLogic/merge-v37x
Merge v3.7.x into main
2 parents 0927598 + f91ad62 commit b274f78

File tree

9 files changed

+393
-120
lines changed

9 files changed

+393
-120
lines changed

‎doc/_static/zenodo_cache/8118151.svg

Lines changed: 35 additions & 0 deletions
Loading

‎doc/devel/contribute.rst

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,9 @@ You've worked out a way to fix it — even better!
1313

1414
You want to tell us about it — best of all!
1515

16-
This project is a community effort, and everyone is welcome to
17-
contribute. Everyone within the community
18-
is expected to abide by our
19-
`code of conduct <https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md>`_.
20-
21-
16+
This project is a community effort, and everyone is welcome to contribute. Everyone
17+
within the community is expected to abide by our `code of conduct
18+
<https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md>`_.
2219

2320
Below, you can find a number of ways to contribute, and how to connect with the
2421
Matplotlib community.
@@ -38,13 +35,12 @@ There are a few typical new contributor profiles:
3835
* **You are a Matplotlib user, and you see a bug, a potential improvement, or
3936
something that annoys you, and you can fix it.**
4037

41-
You can search our issue tracker for an existing issue that describes your
42-
problem or open a new issue to inform us of the problem you observed and
43-
discuss the best approach to fix it. If your contributions would not be
44-
captured on GitHub (social media, communication, educational content), you can
45-
also reach out to us on gitter_,
46-
`Discourse <https://discourse.matplotlib.org/>`__ or attend any of our
47-
`community meetings <https://scientific-python.org/calendars>`__.
38+
You can search our issue tracker for an existing issue that describes your problem or
39+
open a new issue to inform us of the problem you observed and discuss the best approach
40+
to fix it. If your contributions would not be captured on GitHub (social media,
41+
communication, educational content), you can also reach out to us on gitter_,
42+
`Discourse <https://discourse.matplotlib.org/>`__ or attend any of our `community
43+
meetings <https://scientific-python.org/calendars>`__.
4844

4945
* **You are not a regular Matplotlib user but a domain expert: you know about
5046
visualization, 3D plotting, design, technical writing, statistics, or some
@@ -55,8 +51,8 @@ There are a few typical new contributor profiles:
5551
implementation; open an issue or pull request with a starting point, and we'll
5652
be happy to discuss technical approaches.
5753

58-
If you prefer, you can use the
59-
`GitHub functionality for "draft" pull requests <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft>`__
54+
If you prefer, you can use the `GitHub functionality for "draft" pull requests
55+
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft>`__
6056
and request early feedback on whatever you are working on, but you should be
6157
aware that maintainers may not review your contribution unless it has the
6258
"Ready to review" state on GitHub.
@@ -105,9 +101,8 @@ process works, technical questions about the code, what makes for good
105101
documentation or a blog post, how to get involved in community work, or get a
106102
"pre-review" on your PR.
107103

108-
To join, please go to our public community_ channel, and ask
109-
to be added to ``#incubator``. One of our core developers will see your message
110-
and will add you.
104+
To join, please go to our public community_ channel, and ask to be added to
105+
``#incubator``. One of our core developers will see your message and will add you.
111106

112107
New Contributors Meeting
113108
------------------------
@@ -119,8 +114,7 @@ veteran contributors, who are keen to support onboarding of new folks and
119114
share their experience. You can find our community calendar link at the
120115
`Scientific Python website <https://scientific-python.org/calendars/>`_, and
121116
you can browse previous meeting notes on `GitHub
122-
<https://github.com/matplotlib/ProjectManagement/tree/master/
123-
new_contributor_meeting>`_.
117+
<https://github.com/matplotlib/ProjectManagement/tree/master/new_contributor_meeting>`_.
124118
We recommend joining the meeting to clarify any doubts, or lingering
125119
questions you might have, and to get to know a few of the people behind the
126120
GitHub handles 😉. You can reach out to us on gitter_ for any clarifications or
@@ -520,11 +514,10 @@ Then they will receive messages like
520514
DEBUG:matplotlib.yourmodulename:Here is some information
521515
DEBUG:matplotlib.yourmodulename:Here is some more detailed information
522516
523-
Avoid using pre-computed strings (``f-strings``, ``str.format``,etc.) for logging because of security and
524-
performance issues, and because they interfere with style handlers. For example, use ``_log.error('hello %s', 'world')`` rather than
525-
``_log.error('hello {}'.format('world'))`` or ``_log.error(f'hello {s}')``.
526-
527-
517+
Avoid using pre-computed strings (``f-strings``, ``str.format``,etc.) for logging because
518+
of security and performance issues, and because they interfere with style handlers. For
519+
example, use ``_log.error('hello %s', 'world')`` rather than ``_log.error('hello
520+
{}'.format('world'))`` or ``_log.error(f'hello {s}')``.
528521

529522
Which logging level to use?
530523
~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎doc/devel/development_setup.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,16 +90,17 @@ code, as described in :ref:`development-workflow`.
9090
For more information on ``git`` and ``GitHub``, see:
9191

9292
* `Git documentation <https://git-scm.com/doc>`_
93-
* `GitHub-Contributing to a Project <https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
93+
* `GitHub-Contributing to a Project
94+
<https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
9495
* `GitHub Skills <https://skills.github.com/>`_
9596
* :ref:`using-git`
9697
* :ref:`git-resources`
9798
* `Installing git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
98-
* `Managing remote repositories <https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`_
99+
* `Managing remote repositories
100+
<https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`_
99101
* https://tacaswell.github.io/think-like-git.html
100102
* https://tom.preston-werner.com/2009/05/19/the-git-parable.html
101103

102-
103104
.. _dev-environment:
104105

105106
Create a dedicated environment
@@ -147,9 +148,9 @@ The simplest way to do this is to use either Python's virtual environment
147148

148149
Remember to activate the environment whenever you start working on Matplotlib.
149150

150-
151151
Install Matplotlib in editable mode
152152
===================================
153+
153154
Install Matplotlib in editable mode from the :file:`matplotlib` directory
154155
using the command ::
155156

0 commit comments

Comments
 (0)