Skip to content

Commit 221b209

Browse files
glemaitrelesteve
andauthored
DOC update documentation instruction after introducing towncrier (scikit-learn#30083)
Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
1 parent fff920e commit 221b209

File tree

3 files changed

+19
-21
lines changed

3 files changed

+19
-21
lines changed

doc/developers/contributing.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -431,13 +431,17 @@ complies with the following rules before marking a PR as "ready for review". The
431431
non-regression tests should fail for the code base in the ``main`` branch
432432
and pass for the PR code.
433433

434-
5. Follow the :ref:`coding-guidelines`.
434+
5. If your PR is likely to affect users, you need to add a changelog entry describing
435+
your PR changes, see the `following README <https://github.com/scikit-learn/scikit-learn/blob/main/doc/whats_new/upcoming_changes/README.md>`
436+
for more details.
435437

436-
6. When applicable, use the validation tools and scripts in the :mod:`sklearn.utils`
438+
6. Follow the :ref:`coding-guidelines`.
439+
440+
7. When applicable, use the validation tools and scripts in the :mod:`sklearn.utils`
437441
module. A list of utility routines available for developers can be found in the
438442
:ref:`developers-utils` page.
439443

440-
7. Often pull requests resolve one or more other issues (or pull requests).
444+
8. Often pull requests resolve one or more other issues (or pull requests).
441445
If merging your pull request means that some other issues/PRs should
442446
be closed, you should `use keywords to create link to them
443447
<https://github.com/blog/1506-closing-issues-via-pull-requests/>`_
@@ -447,7 +451,7 @@ complies with the following rules before marking a PR as "ready for review". The
447451
related to some other issues/PRs, or it only partially resolves the target
448452
issue, create a link to them without using the keywords (e.g., ``Towards #1234``).
449453

450-
8. PRs should often substantiate the change, through benchmarks of
454+
9. PRs should often substantiate the change, through benchmarks of
451455
performance and efficiency (see :ref:`monitoring_performances`) or through
452456
examples of usage. Examples also illustrate the features and intricacies of
453457
the library to users. Have a look at other examples in the `examples/
@@ -456,14 +460,14 @@ complies with the following rules before marking a PR as "ready for review". The
456460
functionality is useful in practice and, if possible, compare it to other
457461
methods available in scikit-learn.
458462

459-
9. New features have some maintenance overhead. We expect PR authors
460-
to take part in the maintenance for the code they submit, at least
461-
initially. New features need to be illustrated with narrative
462-
documentation in the user guide, with small code snippets.
463-
If relevant, please also add references in the literature, with PDF links
464-
when possible.
463+
10. New features have some maintenance overhead. We expect PR authors
464+
to take part in the maintenance for the code they submit, at least
465+
initially. New features need to be illustrated with narrative
466+
documentation in the user guide, with small code snippets.
467+
If relevant, please also add references in the literature, with PDF links
468+
when possible.
465469

466-
10. The user guide should also include expected time and space complexity
470+
11. The user guide should also include expected time and space complexity
467471
of the algorithm and scalability, e.g. "this algorithm can scale to a
468472
large number of samples > 100000, but does not scale in dimensionality:
469473
`n_features` is expected to be lower than 100".

doc/developers/maintainer.rst.template

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ We adopted the following release schedule:
2929
done as a runnable example and check that its HTML rendering looks correct. It should
3030
be linked from the what's new file for the new version of scikit-learn.
3131

32-
- Ensure that the changelog and commits correspond, and that the changelog is reasonably
33-
well curated. In particular, make sure that the changelog entries are labeled and
34-
ordered within each section. The order of the labels should be `|MajorFeature|`,
35-
`|Feature|`, `|Efficiency|`, `|Enhancement|`, `|Fix|`, and `|API|`.
36-
3732
.. rubric:: Permissions
3833

3934
- The release manager must be a **maintainer** of the
@@ -102,7 +97,7 @@ Reference Steps
10297
- Do not remove lines but drop commit by replacing `pick` with `drop`.
10398
- Commits to pick for a bug-fix release are *generally* prefixed with `FIX`, `CI`,
10499
and `DOC`. They should at least include all the commits of the merged PRs that
105-
were milestoned for this release and/or documented as such in the changelog.
100+
were milestoned for this release.
106101
- Commits to `drop` for a bug-fix release are *generally* prefixed with `FEAT`,
107102
`MAINT`, `ENH`, and `API`. Reasons for not including them is to prevent change
108103
of behavior (which should only happen in major/minor releases).
@@ -148,9 +143,8 @@ Reference Steps
148143
variable in `sklearn/__init__.py`. This means while we are in the release
149144
candidate period, the latest stable is two version behind the `main` branch,
150145
instead of one. In this PR targeting `main`, you should also include a new what's
151-
new file under the `doc/whats_new/` directory so PRs that target the next version
152-
can contribute their changelog entries to this file in parallel to the release
153-
process.
146+
new file under the `doc/whats_new/` directory so that we prepare the
147+
changelog for the next release.
154148
{% endif %}
155149

156150
- In the release branch, change the version number `__version__` in

doc/developers/tips.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ PR-MRG: Add to what's new
234234

235235
::
236236

237-
Please add an entry to the change log at `doc/whats_new/v*.rst`. Like the other entries there, please reference this pull request with `:pr:` and credit yourself (and other contributors if applicable) with `:user:`.
237+
Please add an entry to the future changelog by adding an RST fragment into the module associated with your change located in `doc/whats_new/upcoming_changes`. Refer to the following [README](https://github.com/scikit-learn/scikit-learn/blob/main/doc/whats_new/upcoming_changes/README.md) for full instructions.
238238

239239
PR: Don't change unrelated
240240

0 commit comments

Comments
 (0)