1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
.. _developers-guide-index:
##########
Contribute
##########
.. ifconfig:: releaselevel != 'dev'
.. important::
If you plan to contribute to Matplotlib, please read the
`development version <https://matplotlib.org/devdocs/devel/index.html>`_
of this document as it will have the most up to date installation
instructions, workflow process, and contributing guidelines.
:octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve
Matplotlib! :octicon:`heart;1em;sd-text-info`
This project is a community effort, and everyone is welcome to contribute. Everyone
within the community is expected to abide by our :ref:`code of conduct <code_of_conduct>`.
There are various ways to contribute, such as optimizing and refactoring code,
detailing unclear documentation and writing new examples, helping the community,
reporting and fixing bugs, requesting and implementing new features...
.. _submitting-a-bug-report:
.. _request-a-new-feature:
GitHub issue tracker
====================
The `issue tracker <https://github.com/matplotlib/matplotlib/issues>`_ serves as the
centralized location for making feature requests, reporting bugs, identifying major
projects to work on, and discussing priorities.
We have preloaded the issue creation page with markdown forms requesting the information
we need to triage issues and we welcome you to add any additional information or
context that may be necessary for resolving the issue:
.. grid:: 1 1 2 2
.. grid-item-card::
:class-header: sd-fs-5
:octicon:`bug;1em;sd-text-info` **Submit a bug report**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Thank you for your help in keeping bug reports targeted and descriptive.
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
:expand:
:color: primary
Report a bug
.. grid-item-card::
:class-header: sd-fs-5
:octicon:`light-bulb;1em;sd-text-info` **Request a new feature**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Thank you for your help in keeping feature requests well defined and tightly scoped.
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
:expand:
:color: primary
Request a feature
Since Matplotlib is an open source project with limited resources, we encourage users
to also :ref:`participate <contribute_code>` in fixing bugs and implementing new
features.
Contributing guide
==================
We welcome you to get more involved with the Matplotlib project! If you are new
to contributing, we recommend that you first read our
:ref:`contributing guide<contributing>`:
.. toctree::
:hidden:
contribute
.. grid:: 1 1 2 2
:class-row: sd-fs-5 sd-align-minor-center
.. grid-item::
.. grid:: 1
:gutter: 1
.. grid-item-card::
:link: contribute_code
:link-type: ref
:class-card: sd-shadow-none
:class-body: sd-text-{primary}
:octicon:`code;1em;sd-text-info` Contribute code
.. grid-item-card::
:link: contribute_documentation
:link-type: ref
:class-card: sd-shadow-none
:class-body: sd-text-{primary}
:octicon:`note;1em;sd-text-info` Write documentation
.. grid-item-card::
:link: contribute_triage
:link-type: ref
:class-card: sd-shadow-none
:class-body: sd-text-{primary}
:octicon:`issue-opened;1em;sd-text-info` Triage issues
.. grid-item-card::
:link: other_ways_to_contribute
:link-type: ref
:class-card: sd-shadow-none
:class-body: sd-text-{primary}
:octicon:`globe;1em;sd-text-info` Build community
.. grid-item::
.. grid:: 1
:gutter: 1
.. grid-item::
:octicon:`info;1em;sd-text-info` :ref:`Is this my first contribution? <new_contributors>`
.. grid-item::
:octicon:`question;1em;sd-text-info` :ref:`Where do I ask questions? <get_connected>`
.. grid-item::
:octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I choose an issue? <managing_issues_prs>`
.. grid-item::
:octicon:`codespaces;1em;sd-text-info` :ref:`How do I start a pull request? <how-to-pull-request>`
.. _development_environment:
Development workflow
====================
If you are contributing code or documentation, please follow our guide for setting up
and managing a development environment and workflow:
.. grid:: 1 1 2 2
.. grid-item-card::
:shadow: none
**Install**
^^^
.. toctree::
:maxdepth: 2
development_setup
.. grid-item-card::
:shadow: none
**Workflow**
^^^^
.. toctree::
:maxdepth: 2
development_workflow
.. toctree::
:maxdepth: 1
troubleshooting.rst
.. _contribution_guideline:
Policies and guidelines
=======================
These policies and guidelines help us maintain consistency in the various types
of maintenance work. If you are writing code or documentation, following these policies
helps maintainers more easily review your work. If you are helping triage, community
manage, or release manage, these guidelines describe how our current process works.
.. grid:: 1 1 2 2
:class-row: sf-fs-1
:gutter: 2
.. grid-item-card::
:shadow: none
**Code**
^^^
.. toctree::
:maxdepth: 1
coding_guide
api_changes
testing
.. grid-item-card::
:shadow: none
**Documentation**
^^^
.. toctree::
:maxdepth: 1
document
style_guide
tag_guidelines
.. grid-item-card::
:shadow: none
**Triage And Review**
^^^
.. toctree::
:maxdepth: 1
triage
pr_guide
.. grid-item-card::
:shadow: none
**Maintenance**
^^^
.. toctree::
:maxdepth: 1
release_guide
communication_guide
min_dep_policy
MEP/index
|
