Skip to content

Commit

Permalink
CONTRIBUTING.md: describe adoption/orphaning policy and procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
classabbyamp committed Jul 30, 2023
1 parent c4aaf0d commit 2009cea
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `[email protected]`) 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 <[email protected]>`. 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:
Expand Down

0 comments on commit 2009cea

Please sign in to comment.