From 8f52c28bcca3b5fd90c1c531929d9557304839e8 Mon Sep 17 00:00:00 2001 From: hannah Date: Fri, 29 Sep 2023 10:46:29 -0400 Subject: [PATCH 1/2] turned send to matplotlib into a section and added some more info so it would stand out Co-authored-by: Elliott Sales de Andrade --- doc/devel/contribute.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/devel/contribute.rst b/doc/devel/contribute.rst index 9b53a80ab374..aab1e73f955c 100644 --- a/doc/devel/contribute.rst +++ b/doc/devel/contribute.rst @@ -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 `_ on GitHub if you do not @@ -289,8 +292,13 @@ 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 +`_. For more detailed instructions on how to set up Matplotlib for development and best practices for contribution, see :ref:`installing_for_devs`. From 754ec4518eef8e81ebc131c81a2da475b03b7be1 Mon Sep 17 00:00:00 2001 From: hannah Date: Fri, 29 Sep 2023 10:48:21 -0400 Subject: [PATCH 2/2] changed title level to documented leveling format --- doc/devel/contribute.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/devel/contribute.rst b/doc/devel/contribute.rst index aab1e73f955c..a9bfb0f816dd 100644 --- a/doc/devel/contribute.rst +++ b/doc/devel/contribute.rst @@ -304,7 +304,7 @@ 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 @@ -386,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 @@ -399,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`` @@ -440,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`` @@ -621,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.