File tree Expand file tree Collapse file tree 4 files changed +31
-4
lines changed
Filter options
Expand file tree Collapse file tree 4 files changed +31
-4
lines changed
Original file line number Diff line number Diff line change @@ -340,13 +340,15 @@ then submit a "pull request" (PR). To work on a a pull request:
340340 Matplotlib repository to your own computer or by using Github codespaces, by
341341 following the instructions in :ref: `installing_for_devs `
342342
343- #. **Then ** start a pull request by following the guidance in :ref: `development workflow <development-workflow >`
343+ #. **Then ** start solving the issue, following the guidance in
344+ :ref: `development workflow <development-workflow >`
344345
345- #. **After starting ** check that your contribution meets the :ref: `pull request guidelines <pr-author-guidelines >`
346- and :ref: `update the pull request <update-pull-request >` as needed.
346+ #. **As part of verifying your changes ** check that your contribution meets
347+ the :ref: `pull request guidelines <pr-author-guidelines >`
348+ and then :ref: `open a pull request <open-pull-request >`.
347349
348350#. **Finally ** follow up with maintainers on the PR if waiting more than a few days for
349- feedback.
351+ feedback. :ref: ` Update the pull request < update-pull-request >` as needed.
350352
351353If you have questions of any sort, reach out on the :ref: `contributor_incubator ` and join
352354the :ref: `new_contributors_meeting `.
Original file line number Diff line number Diff line change @@ -146,6 +146,27 @@ The editing workflow
146146.. _why the -a flag? : http://gitready.com/beginner/2009/01/18/the-staging-area.html
147147
148148
149+ Verify your changes
150+ ===================
151+
152+ Check that your change does what you intend. For code changes:
153+
154+ * If the issue you are working on provided a code example, run that example
155+ against your branch and check that you now get the desired result. Note that
156+ adapting the issue example is often a good way to create a new test.
157+
158+ * Run the tests to check that your change has not had unintended consequences
159+ on existing functionality. See :ref: `run_tests `.
160+
161+ For documentation changes, build the documentation locally to check that
162+ it renders how you intended and that any new links work correctly. See
163+ :ref: `build_docs `.
164+
165+ This is also a good time to look through the :ref: `pr-author-guidelines ` and
166+ address as many of the relevant points as you can.
167+
168+ .. _open-pull-request :
169+
149170Open a pull request
150171===================
151172
Original file line number Diff line number Diff line change @@ -52,6 +52,8 @@ To build the documentation you will need to
5252particular the :ref: `additional dependencies <doc-dependencies >` required to
5353build the documentation.
5454
55+ .. _build_docs :
56+
5557Build the docs
5658--------------
5759
Original file line number Diff line number Diff line change @@ -32,6 +32,8 @@ particular the :ref:`additional dependencies <test-dependencies>` for testing.
3232 You have to additionally get the reference images from the repository,
3333 because they are not distributed with pre-built Matplotlib packages.
3434
35+ .. _run_tests :
36+
3537Running the tests
3638-----------------
3739
You can’t perform that action at this time.
0 commit comments