summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBruno Oliveira <nicoddemus@gmail.com>2020-09-17 10:06:04 -0300
committerBruno Oliveira <nicoddemus@gmail.com>2020-09-17 10:06:04 -0300
commit895a8cf2969fa66c5167eaa68453771768c472b0 (patch)
tree0fb74abe726ea00ea4a179c1f003bb82973d3b38 /CONTRIBUTING.rst
parent98608c439f8183c680a00e23d856d66ea9a7b9a3 (diff)
downloadpytest-895a8cf2969fa66c5167eaa68453771768c472b0.tar.gz
Add guidelines section about backporting
From https://github.com/pytest-dev/pytest/pull/7723#issuecomment-693310439
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index e4a3e7c14..48ba147b7 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -406,6 +406,27 @@ actual latest release). The procedure for this is:
* Delete the PR body, it usually contains a duplicate commit message.
+Who does the backporting
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+As mentioned above, bugs should first be fixed on ``master`` (except in rare occasions
+that a bug only happens in a previous release). So who should do the backport procedure described
+above?
+
+1. If the bug was fixed by a core developer, it is the main responsibility of that core developer
+ to do the backport.
+2. However, often the merge is done by another maintainer, in which case it is nice of them to
+ do the backport procedure if they have the time.
+3. For bugs submitted by non-maintainers, it is expected that a core developer will to do
+ the backport, normally the one that merged the PR on ``master``.
+4. If a non-maintainers notices a bug which is fixed on ``master`` but has not been backported
+ (due to maintainers forgetting to apply the *needs backport* label, or just plain missing it),
+ they are also welcome to open a PR with the backport. The procedure is simple and really
+ helps with the maintenance of the project.
+
+All the above are not rules, but merely some guidelines/suggestions on what we should expect
+about backports.
+
Handling stale issues/PRs
-------------------------