diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 07:28:10 +0200 |
|---|---|---|
| committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 19:05:32 +0200 |
| commit | 3339ace20b7b9532c2dc37e2ff24ce9149d65825 (patch) | |
| tree | 0f0411d515e8f29f5dbaefa6b126660fdfe6662a /doc/development_guide/contributor_guide | |
| parent | 7d05adc45e366ba4a2762adaed9b277d2957cace (diff) | |
| download | pylint-git-3339ace20b7b9532c2dc37e2ff24ce9149d65825.tar.gz | |
Upgrade documentation around the changelog
We do not upgrade the scripts at the same time because we
want to avoid conflicts with main and need to merge the
file moved for that.
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Diffstat (limited to 'doc/development_guide/contributor_guide')
| -rw-r--r-- | doc/development_guide/contributor_guide/contribute.rst | 12 | ||||
| -rw-r--r-- | doc/development_guide/contributor_guide/release.md | 8 |
2 files changed, 10 insertions, 10 deletions
diff --git a/doc/development_guide/contributor_guide/contribute.rst b/doc/development_guide/contributor_guide/contribute.rst index 74fe565b7..efc640d5a 100644 --- a/doc/development_guide/contributor_guide/contribute.rst +++ b/doc/development_guide/contributor_guide/contribute.rst @@ -34,13 +34,13 @@ of Pylint as it gives you access to the latest ``ast`` parser. * then run ``pre-commit install`` in the ``pylint`` root directory to enable the git hooks. -- Add a short entry to the ChangeLog describing the change, except for internal - implementation only changes. Not usually required, but for changes other than small - bugs we also add a couple of sentences in the release document for that release, - (`What's New` section). For the release document we usually write some more details, - and it is also a good place to offer examples on how the new change is supposed to work. +- Add a short entry to the change log describing the change, except for internal + implementation only changes. -- Add a short entry in :file:`doc/whatsnew/VERSION.rst`. +- Not usually required, but for changes other than small bugs we also add a couple + of sentences in the release document for that release, (:file:`doc/whatsnew/VERSION.rst`, + `What's New` section). For the release document we usually write some more details, + and it is also a good place to offer examples on how the new change is supposed to work. - If you used multiple emails or multiple names when contributing, add your mails and preferred name in the ``script/.contributors_aliases.json`` file. diff --git a/doc/development_guide/contributor_guide/release.md b/doc/development_guide/contributor_guide/release.md index 6953e7e3d..24bcc3749 100644 --- a/doc/development_guide/contributor_guide/release.md +++ b/doc/development_guide/contributor_guide/release.md @@ -12,8 +12,8 @@ the maintenance branch. If so, release a last patch release first. See date. - Remove the empty changelog for the last unreleased patch version `X.Y-1.Z'`. (For example: `v2.3.5`) -- Check the result of `git diff vX.Y-1.Z' ChangeLog`. (For example: - `git diff v2.3.4 ChangeLog`) +- Check the result of `git diff vX.Y-1.Z' doc/whatsnew`. (For example: + `git diff v2.3.4 doc/whatsnew`) - Install the release dependencies: `pip3 install -r requirements_test.txt` - Bump the version and release by using `tbump X.Y.0 --no-push --no-tag`. (For example: `tbump 2.4.0 --no-push --no-tag`) @@ -65,8 +65,8 @@ maintenance branch we cherry-pick the commit from `main`. We release patch versions when a crash or a bug is fixed on the main branch and has been cherry-picked on the maintenance branch. -- Check the result of `git diff vX.Y-1.Z-1 ChangeLog`. (For example: - `git diff v2.3.4 ChangeLog`) +- Check the result of `git diff vX.Y-1.Z-1 doc/whatsnew`. (For example: + `git diff v2.3.4 doc/whatsnew`) - Install the release dependencies: `pip3 install -r requirements_test.txt` - Bump the version and release by using `tbump X.Y-1.Z --no-push`. (For example: `tbump 2.3.5 --no-push`) |