Skip to content

Navigation Menu

Sign in

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 4416d38

Browse filesBrowse files
story645story645
committed
reorganize contribute page into blocks and cards
1 parent 9b47f81 commit 4416d38
Copy full SHA for 4416d38

File tree

5 files changed

+130
-55
lines changed
Filter options

5 files changed

+130
-55
lines changed

‎doc/devel/contribute.rst

Copy file name to clipboardExpand all lines: doc/devel/contribute.rst
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ contribute. Everyone within the community
1818
is expected to abide by our
1919
`code of conduct <https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md>`_.
2020

21+
22+
2123
Below, you can find a number of ways to contribute, and how to connect with the
2224
Matplotlib community.
2325

@@ -77,7 +79,9 @@ There are a few typical new contributor profiles:
7779
and gaining context on this area by reading the issues and pull requests
7880
touching these subjects is a reasonable approach.
7981

80-
Get Connected
82+
.. _get_connected:
83+
84+
Get connected
8185
=============
8286

8387
Do I really have something to contribute to Matplotlib?
@@ -145,6 +149,7 @@ though not necessarily all at the same time:
145149
- It involves Python features such as decorators and context managers, which
146150
have subtleties due to our implementation decisions.
147151

152+
.. _managing_issues_prs:
148153

149154
Work on an issue
150155
----------------

‎doc/devel/development_setup.rst

Copy file name to clipboardExpand all lines: doc/devel/development_setup.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The simplest way to do this is to use either Python's virtual environment
148148
Remember to activate the environment whenever you start working on Matplotlib.
149149

150150

151-
Installing Matplotlib in editable mode
151+
Install Matplotlib in editable mode
152152
======================================
153153
Install Matplotlib in editable mode from the :file:`matplotlib` directory
154154
using the command ::

‎doc/devel/development_workflow.rst

Copy file name to clipboardExpand all lines: doc/devel/development_workflow.rst
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,8 @@ If you don't think your request is ready to be merged, just say so in your pull
145145
request message and use the "Draft PR" feature of GitHub. This is a good way of
146146
getting some preliminary code review.
147147

148-
Some other things you might want to do
149-
======================================
148+
Manage a pull request
149+
======================
150150

151151
Explore your repository
152152
-----------------------
@@ -163,7 +163,7 @@ To see a linear list of commits for this branch::
163163

164164
.. _recovering-from-mess-up:
165165

166-
Recovering from mess-ups
166+
Recover from mistakes
167167
------------------------
168168

169169
Sometimes, you mess up merges or rebases. Luckily, in git it is
@@ -193,7 +193,7 @@ If you forgot to make a backup branch::
193193

194194
.. _rewriting-commit-history:
195195

196-
Rewriting commit history
196+
Rewrite commit history
197197
------------------------
198198

199199
.. note::
@@ -285,7 +285,7 @@ to replace your already published commits with the new ones.
285285

286286
.. _rebase-on-main:
287287

288-
Rebasing on ``upstream/main``
288+
Rebase onto ``upstream/main``
289289
-----------------------------
290290

291291
Let's say you thought of some work you'd like to do. You
@@ -363,7 +363,7 @@ to replace your already published commits with the new ones.
363363
.. _force-push:
364364

365365

366-
Pushing, with force
366+
Push with force
367367
-------------------
368368

369369

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
+113-47Lines changed: 113 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -5,69 +5,135 @@ Contribute
55
##########
66

77
Thank you for your interest in helping to improve Matplotlib! There are various
8-
ways to contribute to Matplotlib. All of them are super valuable! For example:
8+
ways to contribute: optimizing and refactoring code, detailing unclear
9+
documentation and writing new examples, reporting and fixing bugs and requesting
10+
and implementing new features, helping the community...
911

10-
- cleaning up and optimizing the code base
11-
- creating and sharing examples of using the library
12-
- detailing unclear and missing documentation
13-
- reporting and fixing bugs
14-
- requesting and implementing new features
15-
- helping the community with all of the above
12+
.. grid:: 1 1 2 2
1613

14+
.. grid-item-card::
15+
:class-body: sd-fs-5
1716

18-
If you have any questions on the
19-
process or how to fix something feel free to ask on `gitter
20-
<https://gitter.im/matplotlib/matplotlib>`_ for short questions and on
21-
`discourse <https://discourse.matplotlib.org>`_ for longer questions.
17+
:octicon:`info;1em;sd-text-info` :ref:`start-contributing`
2218

23-
.. rst-class:: sd-d-inline-block
19+
:octicon:`question;1em;sd-text-info` :ref:`get_connected`
2420

25-
.. button-ref:: submitting-a-bug-report
26-
:class: sd-fs-6
27-
:color: primary
21+
:octicon:`issue-opened;1em;sd-text-info` :ref:`new_contributors`
2822

29-
Report a bug
23+
:octicon:`git-pull-request;1em;sd-text-info` :ref:`managing_issues_prs`
3024

31-
.. rst-class:: sd-d-inline-block
25+
.. grid-item::
3226

33-
.. button-ref:: request-a-new-feature
34-
:class: sd-fs-6
35-
:color: primary
27+
.. rst-class:: sd-d-inline-block
3628

37-
Request a feature
29+
.. button-ref:: request-a-new-feature
30+
:class: sd-fs-6
31+
:color: primary
3832

39-
.. rst-class:: sd-d-inline-block
33+
Request a feature
4034

41-
.. button-ref:: contributing-code
42-
:class: sd-fs-6
43-
:color: primary
4435

45-
Contribute code
36+
.. rst-class:: sd-d-inline-block
4637

47-
.. rst-class:: sd-d-inline-block
38+
.. button-ref:: submitting-a-bug-report
39+
:class: sd-fs-6
40+
:color: primary
4841

49-
.. button-ref:: documenting-matplotlib
50-
:class: sd-fs-6
51-
:color: primary
42+
Report a bug
5243

53-
Write documentation
44+
.. rst-class:: sd-d-inline-block
5445

55-
.. toctree::
56-
:maxdepth: 2
57-
58-
contribute.rst
59-
triage.rst
60-
development_setup.rst
61-
development_workflow.rst
62-
testing.rst
63-
document.rst
64-
style_guide.rst
65-
coding_guide.rst
66-
release_guide.rst
67-
dependencies.rst
68-
min_dep_policy.rst
69-
maintainer_workflow.rst
70-
MEP/index
46+
.. button-ref:: contributing-code
47+
:class: sd-fs-6
48+
:color: primary
49+
50+
Contribute code
51+
52+
.. rst-class:: sd-d-inline-block
53+
54+
.. button-ref:: documenting-matplotlib
55+
:class: sd-fs-6
56+
:color: primary
57+
58+
Write documentation
59+
60+
If you are new to contributing, we recommend that you first read our
61+
:ref:`contributing guide<contributing>`. If you are contributing code or
62+
documentation, please follow our guides for setting up and managing a
63+
:ref:`development environment and workflow<development_environment>`.
64+
For code, documentation, or triage, please follow the corresponding
65+
:ref:`contribution guidelines <contribution_guideline>`.
66+
67+
68+
.. _development_environment:
69+
70+
Develop
71+
=======
72+
73+
.. grid:: 1 1 2 2
74+
75+
.. grid-item-card:: Setup
76+
77+
.. toctree::
78+
:maxdepth: 2
79+
80+
development_setup
81+
82+
.. toctree::
83+
:maxdepth: 1
84+
85+
dependencies
86+
Minimum versions <min_dep_policy>
87+
88+
89+
.. grid-item-card:: Workflow
90+
91+
.. toctree::
92+
:maxdepth: 2
93+
94+
development_workflow
95+
96+
97+
98+
.. _contribution_guideline:
99+
100+
Contribution guidelines
101+
=======================
102+
103+
.. grid:: 1 1 2 2
104+
105+
.. grid-item-card:: Code
106+
107+
:ref:`coding_guidelines`
108+
109+
.. toctree::
110+
:maxdepth: 1
111+
112+
coding_guide
113+
testing
114+
115+
.. grid-item-card:: Documentation
116+
117+
.. toctree::
118+
:maxdepth: 1
119+
120+
document
121+
style_guide
122+
123+
.. grid-item-card:: Triage
124+
125+
| :ref:`bug_triaging`
126+
| :ref:`triage_team`
127+
| :ref:`triage_workflow`
128+
129+
.. grid-item-card:: Maintenance
130+
131+
.. toctree::
132+
:maxdepth: 1
133+
134+
maintainer_workflow
135+
release_guide
136+
MEP/index
71137

72138
.. toctree::
73139
:hidden:

‎doc/devel/triage.rst

Copy file name to clipboardExpand all lines: doc/devel/triage.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ The following actions are typically useful:
6262
explores how to lead online discussions in the context of open source.
6363

6464

65+
.. _triage_team:
66+
6567
Triage team
6668
-----------
6769

@@ -121,6 +123,8 @@ can do the following important tasks:
121123
should be closed.
122124

123125

126+
.. _triage_workflow:
127+
124128
A typical workflow for triaging issues
125129
--------------------------------------
126130

0 commit comments

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