diff options
| author | Maxim Cournoyer <maxim.cournoyer@gmail.com> | 2024-12-16 22:35:45 +0900 |
|---|---|---|
| committer | Maxim Cournoyer <maxim.cournoyer@gmail.com> | 2024-12-16 22:39:24 +0900 |
| commit | 097de97982f328a79394b197d3836842bcfbac44 (patch) | |
| tree | 23afd2d9e50f674d13d2ae60eae78a253ba82ec7 | |
| parent | 445eaccd7641c248aaf3b8400ebc13f65848b46d (diff) | |
| download | guix-097de97982f328a79394b197d3836842bcfbac44.tar.gz guix-097de97982f328a79394b197d3836842bcfbac44.zip | |
doc: Document naming convention for work-in-progress branches.
* doc/contributing.texi (Managing Patches and Branches): Extend doc.
Change-Id: I12253a81fe7c954734e68eba08eb5e8c8a434faa
| -rw-r--r-- | doc/contributing.texi | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index 0125f7d107..d4784de452 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -2362,6 +2362,17 @@ information on some builds and substitute availability. Once the branch has been merged, the issue should be closed and the branch deleted. +@cindex work-in-progress branches, wip +@cindex wip branches +Sometimes, a branch may be a work in progress, for example for larger +efforts such as updating the GNOME desktop. In these cases, the branch +name should reflect this by having the @samp{wip-} prefix. The QA +infrastructure will avoid building work-in-progress branches, so that +the available resources can be better focused on building the branches +that are ready to be merged. When the branch is no longer a work in +progress, it should be renamed, with the @samp{wip-} prefix removed, and +only then should the merge requests be created, as documented earlier. + @node Debbugs User Interfaces @subsection Debbugs User Interfaces |