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

Skip to content

Commit 6b5c317

Browse files
committed
added a top level setup link + reshuffling into one open issue block
1 parent dbc906a commit 6b5c317

File tree

2 files changed

+36
-17
lines changed

2 files changed

+36
-17
lines changed

doc/devel/contributing.rst

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -156,15 +156,25 @@ a new PR; duplicate PRs are subject to being closed. However, if the existing
156156
PR is an outline, unlikely to work, or stalled, and the original author is
157157
unresponsive, feel free to open a new PR referencing the old one.
158158

159+
160+
.. _open-an-issue:
161+
162+
Open an issue
163+
=============
164+
165+
Please tell us about bugs in the code and documentation, optimizations and
166+
improvements that we can make, and new features that would be nice to have by
167+
opening an issue on our
168+
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_.
169+
170+
If you would like to help us process issues, please see our
171+
:ref:`triage guide<bug_triaging>`.
172+
173+
159174
.. _submitting-a-bug-report:
160175

161176
Submitting a bug report
162-
=======================
163-
164-
If you find a bug in the code or documentation, do not hesitate to submit a
165-
ticket to the
166-
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_. You are
167-
also welcome to post feature requests or pull requests.
177+
-----------------------
168178

169179
If you are reporting a bug, please do your best to include the following:
170180

@@ -197,16 +207,20 @@ Thank you for your help in keeping bug reports complete, targeted and descriptiv
197207
.. _request-a-new-feature:
198208

199209
Requesting a new feature
200-
========================
210+
------------------------
201211

202-
Please post feature requests to the
203-
`Issue Tracker <https://github.com/matplotlib/matplotlib/issues>`_.
212+
If you are requesting that we implement a feature, please do your best to
213+
include a summary of the problem this feature solves and possible approaches for
214+
implementing the request. When possible, please include any related work, such
215+
as academic papers on the feature and links to how other libraries implement of
216+
the feature.
204217

205218
The Matplotlib developers will give feedback on the feature proposal. Since
206219
Matplotlib is an open source project with limited resources, we encourage
207220
users to then also
208221
:ref:`participate in the implementation <contributing-code>`.
209222

223+
210224
.. _contributing-code:
211225

212226
Contributing code

doc/devel/index.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,36 @@ process or how to fix something feel free to ask on `gitter
2121

2222
.. rst-class:: sd-d-inline-block
2323

24-
.. button-ref:: submitting-a-bug-report
24+
.. button-ref:: open-an-issue
2525
:class: sd-fs-6
2626
:color: primary
2727

28-
Report a bug
28+
Open an issue
2929

3030
.. rst-class:: sd-d-inline-block
3131

32-
.. button-ref:: request-a-new-feature
32+
.. button-ref:: contributing-code
3333
:class: sd-fs-6
3434
:color: primary
3535

36-
Request a feature
36+
Contribute code
3737

3838
.. rst-class:: sd-d-inline-block
3939

40-
.. button-ref:: contributing-code
40+
.. button-ref:: documenting-matplotlib
4141
:class: sd-fs-6
4242
:color: primary
4343

44-
Contribute code
44+
Write documentation
4545

4646
.. rst-class:: sd-d-inline-block
4747

48-
.. button-ref:: documenting-matplotlib
48+
.. button-ref:: development-setup
4949
:class: sd-fs-6
5050
:color: primary
5151

52-
Write documentation
52+
Setup environment
53+
5354

5455
.. toctree::
5556
:maxdepth: 2
@@ -66,6 +67,10 @@ process or how to fix something feel free to ask on `gitter
6667
dependencies.rst
6768
min_dep_policy.rst
6869
maintainer_workflow.rst
70+
71+
.. toctree::
72+
:maxdepth: 1
73+
6974
MEP/index
7075

7176
.. toctree::

0 commit comments

Comments
 (0)