Skip to content

DOC: made "open PR on MPL" a section in contribute guide #26961

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 2 commits into from
Oct 6, 2023
Merged

DOC: made "open PR on MPL" a section in contribute guide #26961

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f52c28
turned send to matplotlib into a section and added some more info so …
story645 Sep 29, 2023
754ec45
changed title level to documented leveling format
story645 Sep 29, 2023
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
22 changes: 15 additions & 7 deletions doc/devel/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,9 @@ Maplotlib repository to your own computer, or alternatively using
in-browser development environment that comes with the appropriated setup to
contribute to Matplotlib.

Workflow overview
^^^^^^^^^^^^^^^^^

A brief overview of the workflow is as follows.

#. `Create an account <https://github.com/join>`_ on GitHub if you do not
Expand Down Expand Up @@ -289,14 +292,19 @@ A brief overview of the workflow is as follows.

git push -u origin my-feature

Finally, go to the web page of your fork of the Matplotlib repo, and click
'Pull request' to send your changes to the maintainers for review.
Open a pull request on Matplotlib
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Finally, go to the web page of *your fork* of the Matplotlib repo, and click
**Compare & pull request** to send your changes to the maintainers for review.
The base repository is ``matplotlib/matplotlib`` and the base branch is
generally ``main``. For more guidance, see GitHub's `pull request tutorial
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork>`_.

For more detailed instructions on how to set up Matplotlib for development and
best practices for contribution, see :ref:`installing_for_devs`.

GitHub Codespaces workflows
~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^

* If you need to open a GUI window with Matplotlib output on Codespaces, our
configuration includes a `light-weight Fluxbox-based desktop
Expand Down Expand Up @@ -378,7 +386,7 @@ This ensures that users are notified before the change will take effect and thus
prevents unexpected breaking of code.

Rules
~~~~~
^^^^^

- Deprecations are targeted at the next point.release (e.g. 3.x)
- Deprecated API is generally removed two point-releases after introduction
Expand All @@ -391,7 +399,7 @@ Rules
API consistency lead developer

Introducing
~~~~~~~~~~~
^^^^^^^^^^^

#. Announce the deprecation in a new file
:file:`doc/api/next_api_changes/deprecations/99999-ABC.rst` where ``99999``
Expand Down Expand Up @@ -432,7 +440,7 @@ Introducing
version number.

Expiring
~~~~~~~~
^^^^^^^^

#. Announce the API changes in a new file
:file:`doc/api/next_api_changes/[kind]/99999-ABC.rst` where ``99999``
Expand Down Expand Up @@ -613,7 +621,7 @@ example, use ``_log.error('hello %s', 'world')`` rather than ``_log.error('hell
{}'.format('world'))`` or ``_log.error(f'hello {s}')``.

Which logging level to use?
~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^

There are five levels at which you can emit messages.

Expand Down