diff options
| author | Ben Nathanson <github@bigriver.xyz> | 2020-10-03 17:03:18 -0400 |
|---|---|---|
| committer | Ben Nathanson <github@bigriver.xyz> | 2020-10-03 17:03:18 -0400 |
| commit | 93b5da05bcaa39d76b07c334690f85d5d54f54df (patch) | |
| tree | 3ad204170ab135de6d5d6b8edfc3ee045276b6a6 /doc/source/dev | |
| parent | 88eda2f2f430e2f3b7e580fe38ac31e4c5fac942 (diff) | |
| download | numpy-93b5da05bcaa39d76b07c334690f85d5d54f54df.tar.gz | |
DOC: Cleaner PR template
Make the instructions easy to see and hard to delete unread.
Moves some text to new sections in dev/development_workflow.rst.
The dashes above and below the heading, which
in monospace seem too long, fit it
well in Chromium browsers and reasonably in Firefox.
Diffstat (limited to 'doc/source/dev')
| -rw-r--r-- | doc/source/dev/development_workflow.rst | 35 |
1 files changed, 26 insertions, 9 deletions
diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index d5a49a9f9..53f3eef91 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -188,6 +188,16 @@ Standard acronyms to start the commit message with are:: REL: related to releasing numpy +.. _workflow_mailing_list: + +Get the mailing list's opinion +======================================================= + +If you plan a new feature or API change, it's wisest to first email the +NumPy `mailing list <https://mail.python.org/mailman/listinfo/numpy-discussion>`_ +asking for comment. If you haven't heard back in a week, it's +OK to ping the list again. + .. _asking-for-merging: Asking for your changes to be merged with the main repo @@ -197,15 +207,22 @@ When you feel your work is finished, you can create a pull request (PR). Github has a nice help page that outlines the process for `filing pull requests`_. If your changes involve modifications to the API or addition/modification of a -function, you should - -- send an email to the `NumPy mailing list`_ with a link to your PR along with - a description of and a motivation for your changes. This may generate - changes and feedback. It might be prudent to start with this step if your - change may be controversial. -- add a release note to the ``doc/release/upcoming_changes/`` directory, - following the instructions and format in the - ``doc/release/upcoming_changes/README.rst`` file. +function, add a release note to the ``doc/release/upcoming_changes/`` +directory, following the instructions and format in the +``doc/release/upcoming_changes/README.rst`` file. + + +Getting your PR reviewed +======================== + +We review pull requests as soon as we can, typically within a week. If you get +no review comments within two weeks, feel free to ask for feedback by +adding a comment on your PR (this will notify maintainers). + +If your PR is large or complicated, asking for input on the numpy-discussion +mailing list may also be useful. + + .. _rebasing-on-master: |