Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

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

 Sign up
Appearance settings

Commit3ba1e42

Browse files
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 burriedinside of contribute.rst. They were a bit foreign there because allother content is on direct involvement with the project, which needsmuch more information.To keep things focussed and directly redirect the "simple" bug reportand feature request topics to GitHub, I've deleted the sections andinstead created two cards at the top of devel/index.rst withessentially the content of the sections. Note that I've the list ofthings to include in bug reports because that's covered by our issuetemplate on GitHub nowadays and does not need repetition here.
1 parent1b36177 commit3ba1e42

File tree

2 files changed

+63
-65
lines changed

2 files changed

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

2174
New contributors
2275
================
@@ -48,32 +101,26 @@ New contributors
48101
:class-row: sd-fs-5
49102

50103
..grid-item-card::
51-
:link:request-a-new-feature
104+
:link:contribute_code
52105
:link-type: ref
53106
:shadow: none
54107

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

57110
..grid-item-card::
58-
:link:submitting-a-bug-report
111+
:link:contribute_documentation
59112
:link-type: ref
60113
:shadow: none
61114

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

64117
..grid-item-card::
65-
:link:contribute_code
118+
:link:other_ways_to_contribute
66119
:link-type: ref
67120
:shadow: none
68121

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
122+
:octicon:`paper-airplane;1em;sd-text-info` Other ways to contribute
75123

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

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

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp