Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 254ce22

Browse files
committed
reorg into cards and grids
1 parent 627379b commit 254ce22

File tree

4 files changed

+77
-50
lines changed

4 files changed

+77
-50
lines changed

doc/devel/contributing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ There are a few typical new contributor profiles:
7575
and gaining context on this area by reading the issues and pull requests
7676
touching these subjects is a reasonable approach.
7777

78+
.. _get_connected:
79+
7880
Get Connected
7981
=============
8082

@@ -143,6 +145,8 @@ though not necessarily all at the same time:
143145
- It involves Python features such as decorators and context managers, which
144146
have subtleties due to our implementation decisions.
145147

148+
.. _managing_issues_prs:
149+
146150
Assigning issues and duplicating pull requests
147151
----------------------------------------------
148152

doc/devel/development_setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The simplest way to do this is to use either Python's virtual environment
144144

145145
Remember to activate the environment whenever you start working on Matplotlib.
146146

147-
Installing Matplotlib in editable mode
147+
Install Matplotlib in editable mode
148148
======================================
149149
Install Matplotlib in editable mode from the :file:`matplotlib` directory
150150
using the command ::

doc/devel/index.rst

Lines changed: 68 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -8,98 +8,117 @@ Thank you for your interest in helping to improve Matplotlib! There are various
88
ways to contribute to Matplotlib. All of them are super valuable but don't necessarily
99
require writing code at all. For example:
1010

11-
- contributing to the documentation
12-
- opening new issues for bugs
13-
- requesting new features
14-
- asking for clarification on things you find unclear
15-
- fixing bugs
16-
17-
If you have any questions on the
18-
process or how to fix something feel free to ask on `gitter
19-
<https://gitter.im/matplotlib/matplotlib>`_ for short questions and on
20-
`discourse <https://discourse.matplotlib.org>`_ for longer questions.
21-
2211
.. rst-class:: sd-d-inline-block
2312

24-
.. button-ref:: request-a-new-feature
25-
:class: sd-fs-6
26-
:color: primary
13+
.. button-ref:: request-a-new-feature
14+
:class: sd-fs-6
15+
:color: primary
2716

28-
Request a feature
17+
Request a feature
2918

3019

3120
.. rst-class:: sd-d-inline-block
3221

33-
.. button-ref:: submitting-a-bug-report
34-
:class: sd-fs-6
35-
:color: primary
22+
.. button-ref:: submitting-a-bug-report
23+
:class: sd-fs-6
24+
:color: primary
3625

37-
Report a bug
26+
Report a bug
3827

3928
.. rst-class:: sd-d-inline-block
4029

41-
.. button-ref:: contributing-code
42-
:class: sd-fs-6
43-
:color: primary
30+
.. button-ref:: contributing-code
31+
:class: sd-fs-6
32+
:color: primary
4433

45-
Contribute code
34+
Contribute code
4635

4736
.. rst-class:: sd-d-inline-block
4837

49-
.. button-ref:: documenting-matplotlib
50-
:class: sd-fs-6
51-
:color: primary
38+
.. button-ref:: documenting-matplotlib
39+
:class: sd-fs-6
40+
:color: primary
41+
42+
Write documentation
43+
44+
If you have any questions on the
45+
process or how to fix something feel free to ask on `gitter
46+
<https://gitter.im/matplotlib/matplotlib>`_ for short questions and on
47+
`discourse <https://discourse.matplotlib.org>`_ for longer questions.
5248

53-
Write documentation
5449

5550
.. card:: Contribute
5651

57-
.. toctree::
58-
:maxdepth: 2
52+
.. grid:: 1 1 2 2
53+
54+
.. grid-item-card::
55+
56+
:ref:`start-contributing`
57+
58+
:ref:`get_connected`
59+
60+
:ref:`new_contributors`
5961

60-
contribute
62+
:ref:`managing_issues_prs`
63+
64+
.. grid-item-card::
65+
66+
:ref:`open-an-issue`
67+
68+
:ref:`contributing-code`
69+
70+
:ref:`contributing_documentation`
71+
72+
:ref:`other_ways_to_contribute`
6173

6274
.. card:: Set up working environment
6375

6476
.. toctree::
6577
:maxdepth: 2
6678

6779
development_setup
68-
development_workflow
6980

7081
.. toctree::
7182
:maxdepth: 1
7283

84+
development_workflow
7385
dependencies
7486
min_dep_policy
7587

7688

77-
.. card:: Contributor Guides
89+
.. card:: Contributor guides
90+
91+
.. grid:: 1 1 2 2
92+
93+
.. grid-item-card:: Code
94+
95+
:ref:`coding_guidelines`
96+
97+
:doc:`coding_guide`
98+
99+
:doc:`testing`
100+
101+
.. grid-item-card:: Documentation
102+
103+
:doc:`documenting_mpl`
104+
105+
:doc:`style_guide`
78106

79-
.. toctree::
80-
:maxdepth: 1
107+
.. grid-item-card:: Triage
81108

82-
contributing:coding_guidelines
83-
coding_guide
84-
testing
109+
:ref:`bug_triaging`
85110

86-
.. toctree::
87-
:maxdepth: 1
111+
:ref:`triage_team`
88112

89-
documenting_mpl
90-
style_guide
113+
:ref:`triage_workflow`
91114

92-
.. toctree::
93-
:maxdepth: 2
115+
.. grid-item-card:: Maintenance
94116

95-
triage
117+
:doc:`maintainer_workflow`
96118

97-
.. toctree::
98-
:maxdepth: 1
119+
:doc:`release_guide`
99120

100-
maintainer_workflow
101-
release_guide
102-
MEP/index
121+
:doc:`MEP/index`
103122

104123
.. toctree::
105124
:hidden:

doc/devel/triage.rst

Lines 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)