Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 15d2b30

Browse filesBrowse files
committed
applying toc styling to remove nesting
change "new contributors" section title to "contributing guide" add copy to anchor each section of devel/index small doc cleanups based on above
1 parent 9b8a8c7 commit 15d2b30
Copy full SHA for 15d2b30

File tree

3 files changed

+47
-34
lines changed
Filter options

3 files changed

+47
-34
lines changed

‎doc/devel/contribute.rst

Copy file name to clipboardExpand all lines: doc/devel/contribute.rst
+5-8Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
.. _contributing:
44

5-
**********
6-
Contribute
7-
**********
5+
******************
6+
Contributing guide
7+
******************
8+
89

910
You've discovered a bug or something else you want to change
1011
in Matplotlib — excellent!
@@ -13,10 +14,6 @@ You've worked out a way to fix it — even better!
1314

1415
You want to tell us about it — best of all!
1516

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>`_.
19-
2017
Below, you can find a number of ways to contribute, and how to connect with the
2118
Matplotlib community.
2219

@@ -275,7 +272,7 @@ repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
275272
then submit a "pull request" (PR). You can do this by cloning a copy of the
276273
Maplotlib repository to your own computer, or alternatively using
277274
`GitHub Codespaces <https://docs.github.com/codespaces>`_, a cloud-based
278-
in-browser development environment that comes with the appropriated setup to
275+
in-browser development environment that comes with the appropriate setup to
279276
contribute to Matplotlib.
280277

281278
Workflow overview

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
+36-22Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,27 @@ Contribute
1616
:octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve
1717
Matplotlib! :octicon:`heart;1em;sd-text-info`
1818

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...
2225

2326
.. _submitting-a-bug-report:
2427
.. _request-a-new-feature:
2528

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+
2640
.. grid:: 1 1 2 2
2741

2842
.. grid-item-card::
@@ -31,9 +45,7 @@ and fixing bugs and requesting and implementing new features...
3145
:octicon:`bug;1em;sd-text-info` **Submit a bug report**
3246
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3347

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.
3749

3850
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
3951
:expand:
@@ -47,27 +59,24 @@ and fixing bugs and requesting and implementing new features...
4759
:octicon:`light-bulb;1em;sd-text-info` **Request a new feature**
4860
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4961

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.
5363

5464
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
5565
:expand:
5666
:color: primary
5767

5868
Request a feature
5969

70+
Since Matplotlib is an open source project with limited resources, we encourage users
71+
to then also :ref:`participate <contribute_code>` in fixing bugs and implementing new
72+
features.
73+
74+
Contributing guide
75+
==================
6076

6177
We welcome you to get more involved with the Matplotlib project! If you are new
6278
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>`:
7180

7281
.. toctree::
7382
:hidden:
@@ -115,13 +124,13 @@ New contributors
115124

116125
:octicon:`globe;1em;sd-text-info` Build community
117126

118-
119-
120-
121127
.. _development_environment:
122128

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:
125134

126135
.. grid:: 1 1 2 2
127136

@@ -159,6 +168,11 @@ Development environment
159168
Policies and guidelines
160169
=======================
161170

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+
162176
.. grid:: 1 1 2 2
163177
:class-row: sf-fs-1
164178
:gutter: 2

‎doc/index.rst

Copy file name to clipboardExpand all lines: doc/index.rst
+6-4Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Install
3131
3232
.. tab-item:: other
3333

34+
.. rst-class:: section-toc
3435
.. toctree::
3536
:maxdepth: 2
3637

@@ -106,6 +107,7 @@ Community
106107

107108
.. grid-item::
108109

110+
.. rst-class:: section-toc
109111
.. toctree::
110112
:maxdepth: 2
111113

@@ -144,11 +146,11 @@ Contribute
144146

145147
.. grid-item::
146148

147-
Matplotlib is a community project maintained for and by its users.
148-
149-
There are many ways you can help!
149+
Matplotlib is a community project maintained for and by its users. See
150+
:ref:`developers-guide-index` for the many ways you can help!
150151

151152
.. grid-item::
153+
.. rst-class:: section-toc
152154
.. toctree::
153155
:maxdepth: 2
154156

@@ -168,7 +170,7 @@ About us
168170
and hard things possible.
169171

170172
.. grid-item::
171-
173+
.. rst-class:: section-toc
172174
.. toctree::
173175
:maxdepth: 2
174176

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.