8000 DOC more explicit guidelines for WIP (#8299) · Sundrique/scikit-learn@070c404 · GitHub
[go: up one dir, main page]

Skip to content

Commit 070c404

Browse files
jnothmanSundrique
authored andcommitted
DOC more explicit guidelines for WIP (scikit-learn#8299)
1 parent 8836acc commit 070c404

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ following rules before you submit a pull request:
7979

8080
- Please prefix the title of your pull request with `[MRG]` (Ready for
8181
Merge), if the contribution is complete and ready for a detailed review.
82-
Incomplete contributions should be prefixed `[WIP]` (to indicate a work
82+
An incomplete contribution -- where you expect to do more work before
83+
receiving a full review -- should be prefixed `[WIP]` (to indicate a work
8384
in progress) and changed to `[MRG]` when it matures. WIPs may be useful
8485
to: indicate you are working on something to avoid duplicated work,
8586
request broad review of functionality or API, or seek collaborators.

doc/developers/contributing.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,9 @@ rules before submitting a pull request:
187187
contribution is complete and should be subjected to a detailed review.
188188
Two core developers will review your code and change the prefix of the pull
189189
request to ``[MRG + 1]`` and ``[MRG + 2]`` on approval, making it eligible
190-
for merging. Incomplete contributions should be prefixed ``[WIP]`` to
191-
indicate a work in progress (and changed to ``[MRG]`` when it matures).
190+
for merging. An incomplete contribution -- where you expect to do more
191+
work before receiving a full review -- should be prefixed ``[WIP]`` (to
192+
indicate a work in progress) and changed to ``[MRG]`` when it matures.
192193
WIPs may be useful to: indicate you are working on something to avoid
193194
duplicated work, request broad review of functionality or API, or seek
194195
collaborators. WIPs often benefit from the inclusion of a

0 commit comments

Comments
 (0)
0