@@ -16,13 +16,27 @@ Contribute
16
16
:octicon: `heart;1em;sd-text-info ` Thank you for your interest in helping to improve
17
17
Matplotlib! :octicon: `heart;1em;sd-text-info `
18
18
19
- There are various ways to contribute: optimizing and refactoring code, detailing
20
- unclear documentation and writing new examples, helping the community, reporting
21
- and fixing bugs and requesting and implementing new features...
19
+ This project is a community effort, and everyone is welcome to contribute. Everyone
20
+ within the community is expected to abide by our :ref: `code of conduct <code_of_conduct >`.
21
+
22
+ There are various ways to contribute, such as optimizing and refactoring code,
23
+ detailing unclear documentation and writing new examples, helping the community,
24
+ reporting and fixing bugs, requesting and implementing new features...
22
25
23
26
.. _submitting-a-bug-report :
24
27
.. _request-a-new-feature :
25
28
29
+ :octicon: `logo-github ` issue tracker
30
+ ====================================
31
+
32
+ The `issue tracker <https://github.com/matplotlib/matplotlib/issues >`_ serves as the
33
+ centralized location for making feature requests, reporting bugs, identifying major
34
+ projects to work on, and discussing priorities.
35
+
36
+ We have preloaded the issue creation page with markdown forms requesting the information
37
+ we need to triage issues and we welcome you to add any additional information or
38
+ context that may be necessary for resolving the issue:
39
+
26
40
.. grid :: 1 1 2 2
27
41
28
42
.. grid-item-card ::
@@ -31,9 +45,7 @@ and fixing bugs and requesting and implementing new features...
31
45
:octicon: `bug;1em;sd-text-info ` **Submit a bug report **
32
46
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
47
34
- We have preloaded the issue creation page with a Markdown form that you can
35
- use to provide relevant context. Thank you for your help in keeping bug reports
36
- complete, targeted and descriptive.
48
+ Thank you for your help in keeping bug reports targeted and descriptive.
37
49
38
50
.. button-link :: https://github.com/matplotlib/matplotlib/issues/new/choose
39
51
:expand:
@@ -47,27 +59,24 @@ and fixing bugs and requesting and implementing new features...
47
59
:octicon: `light-bulb;1em;sd-text-info ` **Request a new feature **
48
60
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49
61
50
- We will give feedback on the feature proposal. Since
51
- Matplotlib is an open source project with limited resources, we encourage
52
- users to then also :ref: `participate in the implementation <contribute_code >`.
62
+ Thank you for your help in keeping feature requests well defined and tightly scoped.
53
63
54
64
.. button-link :: https://github.com/matplotlib/matplotlib/issues/new/choose
55
65
:expand:
56
66
:color: primary
57
67
58
68
Request a feature
59
69
70
+ Since Matplotlib is an open source project with limited resources, we encourage users
71
+ to also :ref: `participate <contribute_code >` in fixing bugs and implementing new
72
+ features.
73
+
74
+ Contributing guide
75
+ ==================
60
76
61
77
We welcome you to get more involved with the Matplotlib project! If you are new
62
78
to contributing, we recommend that you first read our
63
- :ref: `contributing guide<contributing> `. If you are contributing code or
64
- documentation, please follow our guides for setting up and managing a
65
- :ref: `development environment and workflow<development_environment> `.
66
- For code, documentation, or triage, please follow the corresponding
67
- :ref: `contribution guidelines <contribution_guideline >`.
68
-
69
- New contributors
70
- ================
79
+ :ref: `contributing guide<contributing> `:
71
80
72
81
.. toctree ::
73
82
:hidden:
@@ -115,13 +124,13 @@ New contributors
115
124
116
125
:octicon: `globe;1em;sd-text-info ` Build community
117
126
118
-
119
-
120
-
121
127
.. _development_environment :
122
128
123
- Development environment
124
- =======================
129
+ Development workflow
130
+ ====================
131
+
132
+ If you are contributing code or documentation, please follow our guide for setting up
133
+ and managing a development environment and workflow:
125
134
126
135
.. grid :: 1 1 2 2
127
136
@@ -159,6 +168,11 @@ Development environment
159
168
Policies and guidelines
160
169
=======================
161
170
171
+ These policies and guidelines help us maintain consistency in the various types
172
+ of maintenance work. If you are writing code or documentation, following these policies
173
+ helps maintainers more easily review your work. If you are helping triage, community
174
+ manage, or release manage, these guidelines describe how our current process works.
175
+
162
176
.. grid :: 1 1 2 2
163
177
:class-row: sf-fs-1
164
178
:gutter: 2
0 commit comments