Skip to content

reorganize contributing landing page #26086

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
Jun 27, 2023
+138 −60
Merged

reorganize contributing landing page #26086

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
7 changes: 6 additions & 1 deletion doc/devel/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ contribute. Everyone within the community
is expected to abide by our
`code of conduct <https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md>`_.



Below, you can find a number of ways to contribute, and how to connect with the
Matplotlib community.

Expand Down Expand Up @@ -77,7 +79,9 @@ There are a few typical new contributor profiles:
and gaining context on this area by reading the issues and pull requests
touching these subjects is a reasonable approach.

Get Connected
.. _get_connected:

Get connected
=============

Do I really have something to contribute to Matplotlib?
Expand Down Expand Up @@ -145,6 +149,7 @@ though not necessarily all at the same time:
- It involves Python features such as decorators and context managers, which
have subtleties due to our implementation decisions.

.. _managing_issues_prs:

Work on an issue
----------------
Expand Down
4 changes: 2 additions & 2 deletions doc/devel/development_setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ The simplest way to do this is to use either Python's virtual environment
Remember to activate the environment whenever you start working on Matplotlib.


Installing Matplotlib in editable mode
======================================
Install Matplotlib in editable mode
===================================
Install Matplotlib in editable mode from the :file:`matplotlib` directory
using the command ::

Expand Down
18 changes: 9 additions & 9 deletions doc/devel/development_workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ If you don't think your request is ready to be merged, just say so in your pull
request message and use the "Draft PR" feature of GitHub. This is a good way of
getting some preliminary code review.

Some other things you might want to do
======================================
Manage commit history
=====================

Explore your repository
-----------------------
Expand All @@ -163,8 +163,8 @@ To see a linear list of commits for this branch::

.. _recovering-from-mess-up:

Recovering from mess-ups
------------------------
Recover from mistakes
---------------------

Sometimes, you mess up merges or rebases. Luckily, in git it is
relatively straightforward to recover from such mistakes.
Expand Down Expand Up @@ -193,8 +193,8 @@ If you forgot to make a backup branch::

.. _rewriting-commit-history:

Rewriting commit history
------------------------
Rewrite commit history
----------------------

.. note::

Expand Down Expand Up @@ -285,7 +285,7 @@ to replace your already published commits with the new ones.

.. _rebase-on-main:

Rebasing on ``upstream/main``
Rebase onto ``upstream/main``
-----------------------------

Let's say you thought of some work you'd like to do. You
Expand Down Expand Up @@ -363,8 +363,8 @@ to replace your already published commits with the new ones.
.. _force-push:


Pushing, with force
-------------------
Push with force
---------------


If you have in some way re-written already pushed history (e.g. via
Expand Down
165 changes: 117 additions & 48 deletions doc/devel/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,72 +5,141 @@ Contribute
##########

Thank you for your interest in helping to improve Matplotlib! There are various
ways to contribute to Matplotlib. All of them are super valuable! For example:
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...

- cleaning up and optimizing the code base
- creating and sharing examples of using the library
- detailing unclear and missing documentation
- reporting and fixing bugs
- requesting and implementing new features
- helping the community with all of the above
.. card::

.. grid:: 1 1 2 2

If you have any questions on the
process or how to fix something feel free to ask on `gitter
<https://gitter.im/matplotlib/matplotlib>`_ for short questions and on
`discourse <https://discourse.matplotlib.org>`_ for longer questions.
.. grid-item::
:class: sd-fs-5
:child-align: spaced

.. rst-class:: sd-d-inline-block
:octicon:`info;1em;sd-text-info` :ref:`Where should I start? <start-contributing>`

.. button-ref:: submitting-a-bug-report
:class: sd-fs-6
:color: primary
:octicon:`question;1em;sd-text-info` :ref:`Where should I ask questions? <get_connected>`

Report a bug
:octicon:`issue-opened;1em;sd-text-info` :ref:`What are "good-first-issues"? <new_contributors>`

.. rst-class:: sd-d-inline-block
:octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I claim an issue? <managing_issues_prs>`

.. button-ref:: request-a-new-feature
:class: sd-fs-6
:color: primary
.. :octicon:`codespaces;1em;sd-text-info` placeholder for codespaces link

Request a feature
.. grid-item::

.. rst-class:: sd-d-inline-block
.. grid:: 1
:gutter: 1
:class-row: sd-fs-5

.. button-ref:: contributing-code
:class: sd-fs-6
:color: primary
.. grid-item-card::
:link: request-a-new-feature
:link-type: ref

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

.. rst-class:: sd-d-inline-block
.. grid-item-card::
:link: submitting-a-bug-report
:link-type: ref

.. button-ref:: documenting-matplotlib
:class: sd-fs-6
:color: primary
:octicon:`bug;1em;sd-text-info` Submit bug report

Write documentation
.. grid-item-card::
:link: contributing-code
:link-type: ref

.. toctree::
:maxdepth: 2

contribute.rst
triage.rst
development_setup.rst
development_workflow.rst
testing.rst
document.rst
style_guide.rst
coding_guide.rst
release_guide.rst
dependencies.rst
min_dep_policy.rst
maintainer_workflow.rst
MEP/index
:octicon:`code;1em;sd-text-info` Contribute code

.. grid-item-card::
:link: documenting-matplotlib
:link-type: ref

: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
documentation, please follow our guides for setting up and managing a
:ref:`development environment and workflow<development_environment>`.
For code, documentation, or triage, please follow the corresponding
:ref:`contribution guidelines <contribution_guideline>`.


.. _development_environment:

Development workflow
====================

.. grid:: 1 1 2 2

.. grid-item-card:: Install

.. toctree::
:maxdepth: 2

development_setup

.. toctree::
:maxdepth: 1

dependencies
Minimum versions <min_dep_policy>


.. grid-item-card:: Workflow

.. toctree::
:maxdepth: 2

development_workflow



.. _contribution_guideline:

Contribution guides
===================

.. grid:: 1 1 2 2
:class-row: sf-fs-1

.. grid-item-card:: Code

| :ref:`coding_guidelines`

.. toctree::
:maxdepth: 1

coding_guide
testing

.. grid-item-card:: Documentation

.. toctree::
:maxdepth: 1

document
style_guide

.. grid-item-card:: Triage

| :ref:`bug_triaging`
| :ref:`triage_team`
| :ref:`triage_workflow`

.. grid-item-card:: Maintenance

.. toctree::
:maxdepth: 1

maintainer_workflow
release_guide
MEP/index

.. toctree::
:hidden:

license.rst
contribute
triage
license
color_changes
4 changes: 4 additions & 0 deletions doc/devel/triage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ The following actions are typically useful:
explores how to lead online discussions in the context of open source.


.. _triage_team:

Triage team
-----------

Expand Down Expand Up @@ -121,6 +123,8 @@ can do the following important tasks:
should be closed.


.. _triage_workflow:

A typical workflow for triaging issues
--------------------------------------

Expand Down