8000 Addressing review comments · matplotlib/matplotlib@7ad9bbd · GitHub
[go: up one dir, main page]

Skip to content

Commit 7ad9bbd

Browse files
committed
Addressing review comments
1 parent 0e759d3 commit 7ad9bbd

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

doc/devel/coding_guide.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@
1313
Pull request guidelines
1414
***********************
1515

16-
Pull requests (PRs) are the mechanism for contributing to Matplotlib's code and
17-
documentation.
16+
`Pull requests (PRs) on GitHub <https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>`__
17+
are the mechanism for contributing to Matplotlib's code and documentation.
1818

1919
It is recommended to check that your contribution complies with the following
2020
rules before submitting a pull request:
2121

2222
* If your pull request addresses an issue, please use the title to describe the
23-
issue and mention the issue number in the pull request description to ensure
24-
that a link is created to the original issue.
25-
26-
* All public methods should have informative docstrings with sample usage when
27-
appropriate. Use the `numpy docstring standard
28-
<https://numpydoc.readthedocs.io/en/latest/format.html>`_.
23+
issue (e.g. "Add ability to plot timedeltas") and mention the issue number
24+
in the pull request description to ensure that a link is created to the
25+
original issue (e.g. "Closes #8869" or "Fixes #8869"). This will ensure the
26+
original issue mentioned is automatically closed when your PR is merged. See
27+
`the GitHub documentation <https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>`__
28+
for more details.
2929

3030
* Formatting should follow the recommendations of PEP8_, as enforced by
3131
flake8_. You can check flake8 compliance from the command line with ::
@@ -45,6 +45,9 @@ rules before submitting a pull request:
4545
.. __: https://github.com/psf/black/issues/148
4646
.. __: https://github.com/psf/black/issues/1984
4747

48+
* All public methods should have informative docstrings with sample usage when
49+
appropriate. Use the :ref:`docstring standards <writing-docstrings>`.
50+
4851
* Each high-level plotting function should have a simple example in the
4952
``Example`` section of the docstring. This should be as simple as possible
5053
to demonstrate the method. More complex examples should go in the

doc/devel/development_workflow.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ In what follows we'll refer to the upstream Matplotlib ``main`` branch, as
1919
branch".
2020
* Name your branch for the purpose of the changes - e.g.
2121
``bugfix-for-issue-14`` or ``refactor-database-code``.
22-
* If you get stuck, reach out on Gitter or the Mailing list.
23-
* Ask for code review!
22+
* If you get stuck, reach out on Gitter or
23+
`discourse <https://discourse.matplotlib.org>`__.
24+
* Ask for a code review!
2425

2526
This way of working helps to keep work well organized, with readable history.
2627
This in turn makes it easier for project maintainers (that might be you) to see
@@ -155,8 +156,8 @@ Say if there is anything you'd like particular attention for - like a
155156
complicated change or some code you are not happy with.
156157

157158
If you don't think your request is ready to be merged, just say so in your pull
158-
request message. This is still a good way of getting some preliminary code
159-
review.
159+
request message and use the "Draft PR" feature of GitHub. This is a good way of
160+
getting some preliminary code review.
160161

161162
Some other things you might want to do
162163
======================================
@@ -173,9 +174,6 @@ To see a linear list of commits for this branch::
173174

174175
git log
175176

176-
You can also look at the `network graph visualizer <https://github.com/matplotlib/matplotlib/network>`_ for your github
177-
repo.
178-
179177
.. _rebase-on-trunk:
180178

181179
Rebasing on trunk

0 commit comments

Comments
 (0)
0