8000 DOC: Move bug reports and feature requests to top of contributing index · matplotlib/matplotlib@1a0f4d2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1a0f4d2

Browse files
timhoffmtimhoffm
committed
DOC: Move bug reports and feature requests to top of contributing index
Partially adresses #28005. The two sections "Report a bug" and "Request a feature" were burried inside of contribute.rst. They were a bit foreign there because all other content is on direct involvement with the project, which needs much more information. To keep things focussed and directly redirect the "simple" bug report and feature request topics to GitHub, I've deleted the sections and instead created two cards at the top of devel/index.rst with essentially the content of the sections. Note that I've the list of things to include in bug reports because that's covered by our issue template on GitHub nowadays and does not need repetition here.
1 parent 1b36177 commit 1a0f4d2

File tree

2 files changed

+62
-65
lines changed

2 files changed

+62
-65
lines changed

‎doc/devel/contribute.rst

Lines changed: 0 additions & 49 deletions
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

Lines changed: 62 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,62 @@ 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+
As a user, you can give valuable feedback by reporting bugs and suggesting features.
20+
21+
.. _submitting-a-bug-report:
22+
.. _request-a-new-feature:
23+
24+
.. grid:: 2
25+
26+
.. grid-item-card::
27+
:class-header: sd-fs-5
28+
29+
:octicon:`bug;1em;sd-text-info` **Submit a bug report**
30+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31+
32+
If you find a bug in the code or documentation, do not hesitate to submit a
33+
ticket to the
34+
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_.
35+
36+
We have preloaded the issue creation page with a Markdown form that you can
37+
use to provide relevant context. Thank you for your help in keeping bug reports
38+
complete, targeted and descriptive.
39+
40+
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
41+
:expand:
42+
:color: primary
43+
44+
Report a bug on GitHub
45+
46+
.. grid-item-card::
47+
:class-header: sd-fs-5
48+
49+
:octicon:`light-bulb;1em;sd-text-info` **Request a new feature**
50+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51+
52+
Please post feature requests to the
53+
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_.
54+
55+
The Matplotlib developers will give feedback on the feature proposal. Since
56+
Matplotlib is an open source project with limited resources, we encourage
57+
users to then also :ref:`participate in the implementation <contribute_code>`.
58+
59+
.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
60+
:expand:
61+
:color: primary
62+
63+
Post a feature request on GitHub
64+
65+
66+
We also welcome you to get more involved with the Matplotlib project.
67+
There are various ways to contribute:
68+
optimizing and refactoring code, detailing unclear documentation and writing new
69+
examples, reporting and fixing bugs and requesting and implementing new features,
70+
helping the community...
71+
2072

2173
New contributors
2274
================
@@ -48,32 +100,26 @@ New contributors
48100
:class-row: sd-fs-5
49101

50102
.. grid-item-card::
51-
:link: request-a-new-feature
103+
:link: contribute_code
52104
:link-type: ref
53105
:shadow: none
54106

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

57109
.. grid-item-card::
58-
:link: submitting-a-bug-report
110+
:link: contribute_documentation
59111
:link-type: ref
60112
:shadow: none
61113

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

64116
.. grid-item-card::
65-
:link: contribute_code
117+
:link: other_ways_to_contribute
66118
:link-type: ref
67119
:shadow: none
68120

69-
:octicon:`code;1em;sd-text-info` Contribute code
70-
71-
.. grid-item-card::
72-
:link: contribute_documentation
73-
:link-type: ref
74-
:shadow: none
121+
:octicon:`paper-airplane;1em;sd-text-info` Other ways to contribute
75122

76-
:octicon:`note;1em;sd-text-info` Write documentation
77123

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

0 commit comments

Comments
 (0)
0