[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
07/12: doc: Add "Addressing Issues" section.
From: |
guix-commits |
Subject: |
07/12: doc: Add "Addressing Issues" section. |
Date: |
Fri, 18 Jun 2021 08:25:51 -0400 (EDT) |
civodul pushed a commit to branch master
in repository guix.
commit d4751342454a82a4c71c49733f4c5cd221f95b09
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Mon May 24 22:16:23 2021 +0200
doc: Add "Addressing Issues" section.
* doc/contributing.texi (Addressing Issues): New section.
Co-authored-by: Christopher Baines <mail@cbaines.net>
---
doc/contributing.texi | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 228ca63..c0e60b6 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1419,6 +1419,45 @@ you're confident, it's OK to commit.
That last part is subject to being adjusted, allowing individuals to commit
directly on non-controversial changes on parts they’re familiar with.
+@subsection Addressing Issues
+
+Peer review (@pxref{Submitting Patches}) and tools such as
+@command{guix lint} (@pxref{Invoking guix lint}) and the test suite
+(@pxref{Running the Test Suite}) should catch issues before they are
+pushed. Yet, commits that ``break'' functionality might occasionally
+go through. When that happens, there are two priorities: mitigating
+the impact, and understanding what happened to reduce the chance of
+similar incidents in the future. The responsibility for both these
+things primarily lies with those involved, but like everything this is
+a group effort.
+
+Some issues can directly affect all users---for instance because they
+make @command{guix pull} fail or break core functionality, because they
+break major packages (at build time or run time), or because they
+introduce known security vulnerabilities.
+
+@cindex reverting commits
+The people involved in authoring, reviewing, and pushing such
+commit(s) should be at the forefront to mitigate their impact in a
+timely fashion: by pushing a followup commit to fix it (if possible),
+or by reverting it to leave time to come up with a proper fix, and by
+communicating with other developers about the problem.
+
+If these persons are unavailable to address the issue in time, other
+committers are entitled to revert the commit(s), explaining in the
+commit log and on the mailing list what the problem was, with the goal
+of leaving time to the original committer, reviewer(s), and author(s)
+to propose a way forward.
+
+Once the problem has been dealt with, it is the responsibility of
+those involved to make sure the situation is understood. If you are
+working to understand what happened, focus on gathering information
+and avoid assigning any blame. Do ask those involved to describe what
+happened, do not ask them to explain the situation---this would
+implicitly blame them, which is unhelpful. Accountability comes from
+a consensus about the problem, learning from it and improving
+processes so that it's less likely to reoccur.
+
@subsection Commit Revocation
In order to reduce the possibility of mistakes, committers will have
- branch master updated (bccf2a9 -> 2ef71b6), guix-commits, 2021/06/18
- 03/12: lint: check-patch-headers: Recognize Git diffs., guix-commits, 2021/06/18
- 01/12: import: launchpad: Gracefully handle 404s from api.launchpad.net., guix-commits, 2021/06/18
- 04/12: profiles: Add 'load-profile'., guix-commits, 2021/06/18
- 05/12: profiles: Add "XAUTHORITY" to the precious variables., guix-commits, 2021/06/18
- 02/12: build: Remove Guile 2.2 workaround., guix-commits, 2021/06/18
- 08/12: doc: Explain more reasons for commit revocation., guix-commits, 2021/06/18
- 11/12: gnu: xdg-desktop-portal: Update to 1.8.1 and honor XDG_DESKTOP_PORTAL_DIR., guix-commits, 2021/06/18
- 06/12: doc: Structure the "Commit Access" section., guix-commits, 2021/06/18
- 07/12: doc: Add "Addressing Issues" section.,
guix-commits <=
- 09/12: doc: Clarify Git commit signing; fix typo., guix-commits, 2021/06/18
- 10/12: gnu: pipewire: Update to 0.3.29., guix-commits, 2021/06/18
- 12/12: gnu: xdg-desktop-portal-wlr: Update to 0.4.0., guix-commits, 2021/06/18