diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 09:32:49 +0200 |
|---|---|---|
| committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-05-28 11:32:41 +0200 |
| commit | a69755704f402a36cffe18830c5d0899d2e1324c (patch) | |
| tree | 8761d38492ba9a9316e7eb0e3fe74725f722914d /doc/development_guide | |
| parent | 87f1427f4e9f129d9a97ea7d520acc3dce029ce7 (diff) | |
| download | pylint-git-a69755704f402a36cffe18830c5d0899d2e1324c.tar.gz | |
[doc] Add an explanation on versionning scheme in the FAQ
Closes #6676
Diffstat (limited to 'doc/development_guide')
4 files changed, 14 insertions, 0 deletions
diff --git a/doc/development_guide/contributor_guide/contribute.rst b/doc/development_guide/contributor_guide/contribute.rst index b09414a12..74fe565b7 100644 --- a/doc/development_guide/contributor_guide/contribute.rst +++ b/doc/development_guide/contributor_guide/contribute.rst @@ -95,3 +95,12 @@ documentation. To test smaller changes you can consider ``build-html``, which sk $ make build-html We're reusing generated files for speed, use ``make clean`` when you want to start from scratch. + +How to choose the target version ? +---------------------------------- + +Choose depending on the kind of change you're doing: + +.. include:: patch_release.rst +.. include:: minor_release.rst +.. include:: major_release.rst diff --git a/doc/development_guide/contributor_guide/major_release.rst b/doc/development_guide/contributor_guide/major_release.rst new file mode 100644 index 000000000..175ab6bfa --- /dev/null +++ b/doc/development_guide/contributor_guide/major_release.rst @@ -0,0 +1,2 @@ +- In **major releases** (``1.0.0``) we change everything else (pylint options, json output, dev API...) + while still trying to minimize disruption. diff --git a/doc/development_guide/contributor_guide/minor_release.rst b/doc/development_guide/contributor_guide/minor_release.rst new file mode 100644 index 000000000..5f0109e5a --- /dev/null +++ b/doc/development_guide/contributor_guide/minor_release.rst @@ -0,0 +1,2 @@ +- In **minor releases** (``1.2.0``), we add checks, remove checks, drop python interpreters + past end of life, upgrade astroid minor/major versions and fix false negatives. diff --git a/doc/development_guide/contributor_guide/patch_release.rst b/doc/development_guide/contributor_guide/patch_release.rst new file mode 100644 index 000000000..b4e153a88 --- /dev/null +++ b/doc/development_guide/contributor_guide/patch_release.rst @@ -0,0 +1 @@ +- In **patch release** (``1.2.3``), we only fix false positives and crashes. |