Skip to content

Commit 69f9ebf

Browse files
authored
Merge pull request matplotlib#28011 from timhoffm/doc-contribute
DOC: Move bug reports and feature requests to top of contributing index
2 parents feb2780 + 36965ac commit 69f9ebf

File tree

2 files changed

+52
-65
lines changed

2 files changed

+52
-65
lines changed

doc/devel/contribute.rst

-49
Original file line numberDiff line numberDiff line change
@@ -163,55 +163,6 @@ a new PR; duplicate PRs are subject to being closed. However, if the existing
163163
PR is an outline, unlikely to work, or stalled, and the original author is
164164
unresponsive, feel free to open a new PR referencing the old one.
165165

166-
.. _submitting-a-bug-report:
167-
168-
Submit a bug report
169-
===================
170-
171-
If you find a bug in the code or documentation, do not hesitate to submit a
172-
ticket to the
173-
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are
174-
also welcome to post feature requests or pull requests.
175-
176-
If you are reporting a bug, please do your best to include the following:
177-
178-
#. A short, top-level summary of the bug. In most cases, this should be 1-2
179-
sentences.
180-
181-
#. A short, self-contained code snippet to reproduce the bug, ideally allowing
182-
a simple copy and paste to reproduce. Please do your best to reduce the code
183-
snippet to the minimum required.
184-
185-
#. The actual outcome of the code snippet.
186-
187-
#. The expected outcome of the code snippet.
188-
189-
#. The Matplotlib version, Python version and platform that you are using. You
190-
can grab the version with the following commands::
191-
192-
>>> import matplotlib
193-
>>> matplotlib.__version__
194-
'3.4.1'
195-
>>> import platform
196-
>>> platform.python_version()
197-
'3.9.2'
198-
199-
We have preloaded the issue creation page with a Markdown form that you can
200-
use to organize this information.
201-
202-
Thank you for your help in keeping bug reports complete, targeted and descriptive.
203-
204-
.. _request-a-new-feature:
205-
206-
Request a new feature
207-
=====================
208-
209-
Please post feature requests to the
210-
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_.
211-
212-
The Matplotlib developers will give feedback on the feature proposal. Since
213-
Matplotlib is an open source project with limited resources, we encourage
214-
users to then also :ref:`participate in the implementation <contribute_code>`.
215166

216167
.. _contribute_code:
217168

doc/devel/index.rst

+52-16
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,52 @@ Contribute
1313
of this document as it will have the most up to date installation
1414
instructions, workflow process, and contributing guidelines.
1515

16-
Thank you for your interest in helping to improve Matplotlib! There are various
17-
ways to contribute: optimizing and refactoring code, detailing unclear
18-
documentation and writing new examples, reporting and fixing bugs and requesting
19-
and implementing new features, helping the community...
16+
:octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve
17+
Matplotlib! :octicon:`heart;1em;sd-text-info`
18+
19+
.. _submitting-a-bug-report:
20+
.. _request-a-new-feature:
21+
22+
.. grid:: 1 1 2 2
23+
24+
.. grid-item-card::
25+
:class-header: sd-fs-5
26+
27+
:octicon:`bug;1em;sd-text-info` **Submit a bug report**
28+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
29+
30+
We have preloaded the issue creation page with a Markdown form that you can
31+
use to provide relevant context. Thank you for your help in keeping bug reports
32+
complete, targeted and descriptive.
33+
34+
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
35+
:expand:
36+
:color: primary
37+
38+
Report a bug
39+
40+
.. grid-item-card::
41+
:class-header: sd-fs-5
42+
43+
:octicon:`light-bulb;1em;sd-text-info` **Request a new feature**
44+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45+
46+
We will give feedback on the feature proposal. Since
47+
Matplotlib is an open source project with limited resources, we encourage
48+
users to then also :ref:`participate in the implementation <contribute_code>`.
49+
50+
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
51+
:expand:
52+
:color: primary
53+
54+
Request a feature
55+
56+
57+
We welcome you to get more involved with the Matplotlib project.
58+
There are various ways to contribute:
59+
optimizing and refactoring code, detailing unclear documentation and writing new
60+
examples, helping the community, reporting and fixing bugs and requesting and
61+
implementing new features...
2062

2163
New contributors
2264
================
@@ -48,32 +90,26 @@ New contributors
4890
:class-row: sd-fs-5
4991

5092
.. grid-item-card::
51-
:link: request-a-new-feature
93+
:link: contribute_code
5294
:link-type: ref
5395
:shadow: none
5496

55-
:octicon:`light-bulb;1em;sd-text-info` Request new feature
97+
:octicon:`code;1em;sd-text-info` Contribute code
5698

5799
.. grid-item-card::
58-
:link: submitting-a-bug-report
100+
:link: contribute_documentation
59101
:link-type: ref
60102
:shadow: none
61103

62-
:octicon:`bug;1em;sd-text-info` Submit bug report
104+
:octicon:`note;1em;sd-text-info` Write documentation
63105

64106
.. grid-item-card::
65-
:link: contribute_code
107+
:link: other_ways_to_contribute
66108
:link-type: ref
67109
:shadow: none
68110

69-
:octicon:`code;1em;sd-text-info` Contribute code
111+
:octicon:`paper-airplane;1em;sd-text-info` Other ways to contribute
70112

71-
.. grid-item-card::
72-
:link: contribute_documentation
73-
:link-type: ref
74-
:shadow: none
75-
76-
:octicon:`note;1em;sd-text-info` Write documentation
77113

78114
If you are new to contributing, we recommend that you first read our
79115
:ref:`contributing guide<contributing>`. If you are contributing code or

0 commit comments

Comments
 (0)