From 93b5da05bcaa39d76b07c334690f85d5d54f54df Mon Sep 17 00:00:00 2001 From: Ben Nathanson Date: Sat, 3 Oct 2020 17:03:18 -0400 Subject: 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. --- doc/source/dev/development_workflow.rst | 35 ++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) (limited to 'doc/source/dev/development_workflow.rst') 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 `_ +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: -- cgit v1.2.1 From 1edd9693c2879e41d1f787a0731b49e286985c22 Mon Sep 17 00:00:00 2001 From: Ben Nathanson Date: Sat, 3 Oct 2020 17:11:32 -0400 Subject: DOC: Fixes for PR 17440 Colon missing in heading. Added sphinx anchor for PR-timeline (html anchor was OK). --- doc/source/dev/development_workflow.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/source/dev/development_workflow.rst') diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index 53f3eef91..1665cfddb 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -212,6 +212,8 @@ directory, following the instructions and format in the ``doc/release/upcoming_changes/README.rst`` file. +.. _workflow_PR_timeline: + Getting your PR reviewed ======================== -- cgit v1.2.1 From 8bb56b7325beddb74ca08696bcc2d3c184047279 Mon Sep 17 00:00:00 2001 From: Alexander Kuhn-Regnier Date: Wed, 21 Oct 2020 23:14:53 +0100 Subject: DOC: Fix typos (general documentation) --- doc/source/dev/development_workflow.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/dev/development_workflow.rst') diff --git a/doc/source/dev/development_workflow.rst b/doc/source/dev/development_workflow.rst index 1665cfddb..34535b2f5 100644 --- a/doc/source/dev/development_workflow.rst +++ b/doc/source/dev/development_workflow.rst @@ -309,7 +309,7 @@ Rewriting commit history Do this only for your own feature branches. -There's an embarrassing typo in a commit you made? Or perhaps the you +There's an embarrassing typo in a commit you made? Or perhaps you made several false starts you would like the posterity not to see. This can be done via *interactive rebasing*. -- cgit v1.2.1