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

Skip to content

DOC: Move bug reports and feature requests to top of contributing index #28011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2024
Merged

DOC: Move bug reports and feature requests to top of contributing index #28011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 0 additions & 49 deletions doc/devel/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/matplotlib/matplotlib/issues>`_. 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 <https://github.com/matplotlib/matplotlib/issues>`_.

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>`.

.. _contribute_code:

Expand Down
68 changes: 52 additions & 16 deletions doc/devel/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,52 @@ 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`

.. _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**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We 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>`.

.. button-link:: https://github.com/matplotlib/matplotlib/issues/new/choose
:expand:
:color: primary

Request a feature


We 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, helping the community, reporting and fixing bugs and requesting and
implementing new features...

New contributors
================
Expand Down Expand Up @@ -48,32 +90,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
:octicon:`paper-airplane;1em;sd-text-info` Other ways to contribute

.. grid-item-card::
:link: contribute_documentation
:link-type: ref
:shadow: none

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

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