You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* All public methods should have informative docstrings with sample usage when
52
-
appropriate. Use the :ref:`docstring standards <writing-docstrings>`.
53
-
54
-
* For high-level plotting functions, consider adding a simple example either in
55
-
the ``Example`` section of the docstring or the
56
-
:ref:`examples gallery <gallery>`.
57
-
58
-
* Changes (both new features and bugfixes) should have good test coverage. See
59
-
:ref:`testing` for more details.
11
+
We value contributions from people with all levels of experience. In particular,
12
+
if this is your first PR not everything has to be perfect. We'll guide you
13
+
through the PR process. Nevertheless, please try to follow our guidelines as well
14
+
as you can to help make the PR process quick and smooth. If your pull request is
15
+
incomplete or a work-in-progress, please mark it as a `draft pull requests <https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests>`_
16
+
on GitHub and specify what feedback from the developers would be helpful.
60
17
61
-
* Import the following modules using the standard scipy conventions::
18
+
Please be patient with reviewers. We try our best to respond quickly, but we have
19
+
limited bandwidth. If there is no feedback within a couple of days, please ping
20
+
us by posting a comment to your PR.
62
21
63
-
import numpy as np
64
-
import numpy.ma as ma
65
-
import matplotlib as mpl
66
-
import matplotlib.pyplot as plt
67
-
import matplotlib.cbook as cbook
68
-
import matplotlib.patches as mpatches
69
22
70
-
In general, Matplotlib modules should **not** import `.rcParams` using ``from
71
-
matplotlib import rcParams``, but rather access it as ``mpl.rcParams``. This
72
-
is because some modules are imported very early, before the `.rcParams`
73
-
singleton is constructed.
23
+
Summary for pull request authors
24
+
================================
74
25
75
-
* If your change is a major new feature, add an entry to the ``What's new``
76
-
section by adding a new file in ``doc/users/next_whats_new`` (see
77
-
:file:`doc/users/next_whats_new/README.rst` for more information).
26
+
We recommend that you check that your contribution complies with the following
27
+
guidelines before submitting a pull request:
78
28
79
-
* If you change the API in a backward-incompatible way, please document it in
80
-
:file:`doc/api/next_api_changes/behavior`, by adding a new file with the
81
-
naming convention ``99999-ABC.rst`` where the pull request number is followed
82
-
by the contributor's initials. (see :file:`doc/api/api_changes.rst` for more
83
-
information)
29
+
.. rst-class:: checklist
84
30
85
-
* If you add new public API or change public API, update or add the
86
-
corresponding type hints. Most often this is found in the corresponding
87
-
``.pyi`` file for the ``.py`` file which was edited. Changes in ``pyplot.py``
88
-
are type hinted inline.
31
+
* Changes, both new features and bugfixes, should have good test coverage. See
32
+
:ref:`testing` for more details.
89
33
90
-
* See below for additional points about :ref:`keyword-argument-processing`, if
91
-
applicable for your pull request.
34
+
* Update the :ref:`documentation <pr-documentation>` if necessary.
92
35
93
-
.. note::
36
+
* All public methods should have informative docstrings with sample usage when
37
+
appropriate. Use the :ref:`docstring standards <writing-docstrings>`.
94
38
95
-
The current state of the Matplotlib code base is not compliant with all
96
-
of these guidelines, but we expect that enforcing these constraints on all
97
-
new contributions will move the overall code base quality in the right
98
-
direction.
39
+
* For high-level plotting functions, consider adding a small example to the
40
+
:ref:`examples gallery <gallery>`.
99
41
42
+
* If you add a major new feature or change the API in a backward-incompatible
43
+
way, please document it as described in :ref:`new-changed-api`
100
44
101
-
.. seealso::
45
+
* Code should follow our conventions as documented in our :ref:`coding_guidelines`
102
46
103
-
* :ref:`coding_guidelines`
104
-
* :ref:`testing`
105
-
* :ref:`documenting-matplotlib`
47
+
* When adding or changing public function signatures, add :ref:`type hints <type-hints>`
106
48
49
+
* When adding keyword arguments, see our guide to :ref:`keyword-argument-processing`.
107
50
51
+
When opening a pull request on Github, please ensure that:
108
52
109
-
Summary for pull request authors
110
-
================================
111
-
112
-
.. note::
53
+
.. rst-class:: checklist
113
54
114
-
* We value contributions from people with all levels of experience. In
115
-
particular if this is your first PR not everything has to be perfect.
116
-
We'll guide you through the PR process.
117
-
* Nevertheless, please try to follow the guidelines below as well as you can to
118
-
help make the PR process quick and smooth.
119
-
* Be patient with reviewers. We try our best to respond quickly, but we
120
-
have limited bandwidth. If there is no feedback within a couple of days,
121
-
please ping us by posting a comment to your PR.
55
+
* Changes were made on a :ref:`feature branch <make-feature-branch>`.
122
56
123
-
When making a PR, pay attention to:
57
+
* :ref:`pre-commit <pre-commit-hooks>` checks for spelling, formatting, etc pass
124
58
125
-
.. rst-class:: checklist
59
+
* The pull request targets the :ref:`main branch <pr-branch-selection>`
126
60
127
-
* :ref:`Target the main branch <pr-branch-selection>`.
128
-
* Adhere to the :ref:`coding_guidelines`.
129
-
* Update the :ref:`documentation <pr-documentation>` if necessary.
130
-
* Aim at making the PR as "ready-to-go" as you can. This helps to speed up
131
-
the review process.
132
-
* It is ok to open incomplete or work-in-progress PRs if you need help or
133
-
feedback from the developers. You may mark these as
* When updating your PR, instead of adding new commits to fix something, please
137
-
consider amending your initial commit(s) to keep the history clean.
138
-
You can achieve this by using
61
+
* If your pull request addresses an issue, please use the title to describe the
62
+
issue (e.g. "Add ability to plot timedeltas") and mention the issue number
63
+
in the pull request description to ensure that a link is created to the
64
+
original issue (e.g. "Closes #8869" or "Fixes #8869"). This will ensure the
65
+
original issue mentioned is automatically closed when your PR is merged. For more
66
+
details, see `linking an issue and pull request <https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>`__.
0 commit comments