@@ -380,6 +380,41 @@ Once you have pushed your commits to your remote repository, you can submit
380380a PR by clicking the "Compare & pull request" button on GitHub,
381381targeting the skrub repository.
382382
383+ Updating the changelog
384+ ~~~~~~~~~~~~~~~~~~~~~~
385+ Any user-facing change to the codebase needs to be reported in the changelog,
386+ found in the ``CHANGES.rst `` file in the root of the repository. A user-facing
387+ change is any change to a functionality of skrub that users are expected to interact
388+ with: for example, adding or removing a parameter, adding a new transformer,
389+ deprecating a function, etc.
390+
391+ Changes made in the test suite, or changes made in the
392+ private parts of the library, should not be reported, unless they bring some benefit
393+ to the user (such as performance improvements). Normally, changes made to the
394+ documentation, such as typo or formatting fixes, are not reported either, while
395+ new examples usually can be added.
396+ Depending on the nature of the PR, a maintainer may add the "no
397+ changelog needed" label to skip the corresponding check if a changelog entry isn't
398+ relevant.
399+
400+ Changelog entries need to follow a specific format: the change should be described
401+ in sufficient detail for users to understand how they may be affected, and the
402+ entry must list both the PR number and the GitHub username of the author(s) of the
403+ PR.
404+
405+ Here is an example:
406+
407+ .. code :: bash
408+
409+ - :meth:` DataOp.skb.apply` now allows passing extra named arguments to the
410+ estimator' s methods through the parameters ``fit_kwargs``, ``predict_kwargs``
411+ etc. :pr:`1642` by :user:`Jérôme Dockès <jeromedockes>`.
412+
413+ The PR number is reported with the directive ``:pr:`NUMBER```, and the author
414+ of the PR uses the directive ``:user:`AUTHOR NAME <GITHUB HANDLE>```.
415+
416+ Missing changelog entries, or changelog entries that do not follow the format,
417+ will fail the changelog check in the CI.
383418
384419Continuous Integration (CI)
385420~~~~~~~~~~~~~~~~~~~~~~~~~~~
0 commit comments