diff --git a/doc/devel/contribute.rst b/doc/devel/contribute.rst index 510b67eead91..4c6934b25fc4 100644 --- a/doc/devel/contribute.rst +++ b/doc/devel/contribute.rst @@ -163,55 +163,6 @@ a new PR; duplicate PRs are subject to being closed. However, if the existing PR is an outline, unlikely to work, or stalled, and the original author is unresponsive, feel free to open a new PR referencing the old one. -.. _submitting-a-bug-report: - -Submit a bug report -=================== - -If you find a bug in the code or documentation, do not hesitate to submit a -ticket to the -`Issue Tracker `_. You are -also welcome to post feature requests or pull requests. - -If you are reporting a bug, please do your best to include the following: - -#. A short, top-level summary of the bug. In most cases, this should be 1-2 - sentences. - -#. A short, self-contained code snippet to reproduce the bug, ideally allowing - a simple copy and paste to reproduce. Please do your best to reduce the code - snippet to the minimum required. - -#. The actual outcome of the code snippet. - -#. The expected outcome of the code snippet. - -#. The Matplotlib version, Python version and platform that you are using. You - can grab the version with the following commands:: - - >>> import matplotlib - >>> matplotlib.__version__ - '3.4.1' - >>> import platform - >>> platform.python_version() - '3.9.2' - -We have preloaded the issue creation page with a Markdown form that you can -use to organize this information. - -Thank you for your help in keeping bug reports complete, targeted and descriptive. - -.. _request-a-new-feature: - -Request a new feature -===================== - -Please post feature requests to the -`Issue Tracker `_. - -The Matplotlib developers will give feedback on the feature proposal. Since -Matplotlib is an open source project with limited resources, we encourage -users to then also :ref:`participate in the implementation `. .. _contribute_code: diff --git a/doc/devel/index.rst b/doc/devel/index.rst index 3ddbcba198a0..cc626d82a672 100644 --- a/doc/devel/index.rst +++ b/doc/devel/index.rst @@ -13,10 +13,62 @@ Contribute of this document as it will have the most up to date installation instructions, workflow process, and contributing guidelines. -Thank you for your interest in helping to improve Matplotlib! There are various -ways to contribute: optimizing and refactoring code, detailing unclear -documentation and writing new examples, reporting and fixing bugs and requesting -and implementing new features, helping the community... +:octicon:`heart;1em;sd-text-info` Thank you for your interest in helping to improve +Matplotlib! :octicon:`heart;1em;sd-text-info` + +As a user, you can give valuable feedback by reporting bugs and suggesting features. + +.. _submitting-a-bug-report: +.. _request-a-new-feature: + +.. grid:: 1 1 2 2 + + .. grid-item-card:: + :class-header: sd-fs-5 + + :octicon:`bug;1em;sd-text-info` **Submit a bug report** + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + If you find a bug in the code or documentation, do not hesitate to submit a + ticket to the + `Issue Tracker `_. + + We have preloaded the issue creation page with a Markdown form that you can + use to provide relevant context. Thank you for your help in keeping bug reports + complete, targeted and descriptive. + + .. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose + :expand: + :color: primary + + Report a bug + + .. grid-item-card:: + :class-header: sd-fs-5 + + :octicon:`light-bulb;1em;sd-text-info` **Request a new feature** + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Please post feature requests to the + `Issue Tracker `_. + + The Matplotlib developers will give feedback on the feature proposal. Since + Matplotlib is an open source project with limited resources, we encourage + users to then also :ref:`participate in the implementation `. + + .. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose + :expand: + :color: primary + + Request a feature + + +We also welcome you to get more involved with the Matplotlib project. +There are various ways to contribute: +optimizing and refactoring code, detailing unclear documentation and writing new +examples, reporting and fixing bugs and requesting and implementing new features, +helping the community... + New contributors ================ @@ -48,32 +100,26 @@ New contributors :class-row: sd-fs-5 .. grid-item-card:: - :link: request-a-new-feature + :link: contribute_code :link-type: ref :shadow: none - :octicon:`light-bulb;1em;sd-text-info` Request new feature + :octicon:`code;1em;sd-text-info` Contribute code .. grid-item-card:: - :link: submitting-a-bug-report + :link: contribute_documentation :link-type: ref :shadow: none - :octicon:`bug;1em;sd-text-info` Submit bug report + :octicon:`note;1em;sd-text-info` Write documentation .. grid-item-card:: - :link: contribute_code + :link: other_ways_to_contribute :link-type: ref :shadow: none - :octicon:`code;1em;sd-text-info` Contribute code - - .. grid-item-card:: - :link: contribute_documentation - :link-type: ref - :shadow: none + :octicon:`paper-airplane;1em;sd-text-info` Other ways to contribute - :octicon:`note;1em;sd-text-info` Write documentation If you are new to contributing, we recommend that you first read our :ref:`contributing guide`. If you are contributing code or