aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorclassabbyamp <void@placeviolette.net>2023-07-23 15:03:01 +0000
committerclassabbyamp <5366828+classabbyamp@users.noreply.github.com>2023-07-30 03:53:01 +0000
commit2009cea22f17403dd67dacac483cc364d4f252d4 (patch)
treeb1c08af310b6db3de88be51933a8b8bac021719a /CONTRIBUTING.md
parentc4aaf0d5793dcca5e88b0f98605790e6cc4271e1 (diff)
downloadvoid-packages-2009cea22f17403dd67dacac483cc364d4f252d4.tar
void-packages-2009cea22f17403dd67dacac483cc364d4f252d4.tar.gz
void-packages-2009cea22f17403dd67dacac483cc364d4f252d4.tar.bz2
void-packages-2009cea22f17403dd67dacac483cc364d4f252d4.tar.lz
void-packages-2009cea22f17403dd67dacac483cc364d4f252d4.tar.xz
void-packages-2009cea22f17403dd67dacac483cc364d4f252d4.tar.zst
void-packages-2009cea22f17403dd67dacac483cc364d4f252d4.zip
CONTRIBUTING.md: describe adoption/orphaning policy and procedure
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a8f58bbb374..471b0ed2ddc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -82,6 +82,29 @@ The checksum can be updated automatically with the `xgensum` helper from the [xt
$ xgensum -i <pkgname>
+### Adopting a template
+
+If a template is orphaned (maintained by `orphan@voidlinux.org`) or the current `maintainer` has not contributed to
+Void in over a year, template maintainership can be adopted by someone else. To ensure a template gets the care it needs,
+template adopters should be familiar with the package and have an established history of contributions to Void.
+Those who have contributed several updates, especially for the template in question, are good candidates for template
+maintainership.
+
+It is best to adopt a template when making another change to it. When adopting the template, add your name or username
+and email to the `maintainer` field in the template, and mention the adoption in your commit message, for example:
+
+ libfoo: update to 1.2.3, adopt.
+
+### Orphaning a template
+
+If you no longer wish to maintain a template, you can remove yourself as maintainer by setting the `maintainer` field in
+the template to `Orphaned <orphan@voidlinux.org>`. The commit message should mention this, for example:
+
+ libfoo: orphan.
+
+It is not necessary to make other changes to the template when orphaning, and incrementing the revision (triggering a
+rebuild) is not necessary either.
+
### Committing your changes
After making your changes, please check that the package builds successfully. From the top level directory of your local copy of the `void-packages` repository, run: