Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes
@ 2022-08-05 20:15 classabbyamp
  2022-08-05 20:27 ` [PR REVIEW] " paper42
                   ` (34 more replies)
  0 siblings, 35 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-05 20:15 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 610 bytes --]

There is a new pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes



A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 7477 bytes --]

From d8d47df9021e5aa4707174be6833a237010634ba Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
---
 CONTRIBUTING.md | 54 ++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 42 insertions(+), 12 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..1b4d31d48a3a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,25 +4,43 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating and updating packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
 For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
 
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
+    # with SSH set up for GitHub (recommended)
     $ git clone git@github.com:<user>/void-packages.git
+    # without SSH set up for GitHub
+    $ git clone https://github.com/<user>/void-packages.git
 
 To keep your forked repository up to date, setup the `upstream` remote to pull in new changes:
 
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged.
+It makes it harder to update your pull request later on and makes it harder to test the changes you have made.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
 You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
@@ -33,26 +51,38 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
+### Updating a template
+
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
+
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
+
+### Committing your changes
+
 When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
 
     $ xlint template
 
 If `xlint` reports any issues, resolve them before committing.
 
-### Committing your changes
-
 Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+* for package removals, use `<pkgname>: remove package` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
 
 * for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
 
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
 If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
 
 `xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
@@ -69,8 +99,8 @@ Your package must build successfully for at least x86, but we recommend trying t
 
     $ ./xbps-src -a armv7l pkg <pkgname>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
 ### Starting a pull request
 

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
@ 2022-08-05 20:27 ` paper42
  2022-08-05 20:27 ` paper42
                   ` (33 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-05 20:27 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 294 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939203828

Comment:
Are you sure the remote is always called upstream after the clone? I think I remember some issues with remote naming, but I don't know what it was.

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
  2022-08-05 20:27 ` [PR REVIEW] " paper42
@ 2022-08-05 20:27 ` paper42
  2022-08-05 20:27 ` paper42
                   ` (32 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-05 20:27 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 192 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939202881

Comment:
and ideally add the reason to the commit body

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
  2022-08-05 20:27 ` [PR REVIEW] " paper42
  2022-08-05 20:27 ` paper42
@ 2022-08-05 20:27 ` paper42
  2022-08-05 20:28 ` classabbyamp
                   ` (31 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-05 20:27 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 233 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939201493

Comment:
one line says runtime testing is strongly encouraged, the other one that it's required

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (2 preceding siblings ...)
  2022-08-05 20:27 ` paper42
@ 2022-08-05 20:28 ` classabbyamp
  2022-08-05 20:31 ` paper42
                   ` (30 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-05 20:28 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 515 bytes --]

New review comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939205651

Comment:
yes

```
$ gh repo clone --help
...
If the repository is a fork, its parent repository will be added as an additional
git remote called "upstream". The remote name can be configured using `--upstream-remote-name`.
The `--upstream-remote-name` option supports an "@owner" value which will name
the remote after the owner of the parent repository.
...
```

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (3 preceding siblings ...)
  2022-08-05 20:28 ` classabbyamp
@ 2022-08-05 20:31 ` paper42
  2022-08-05 20:32 ` paper42
                   ` (29 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-05 20:31 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 284 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939205444

Comment:
```suggestion
## Creating, updating and modifying packages in Void by yourself
```
or something similar that includes other modifications

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (4 preceding siblings ...)
  2022-08-05 20:31 ` paper42
@ 2022-08-05 20:32 ` paper42
  2022-08-05 20:33 ` paper42
                   ` (28 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-05 20:32 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 267 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939207720

Comment:
That sounds like it's called upstream only if it's a fork and we are cloning void-linux/void-packages which isn't a fork

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (5 preceding siblings ...)
  2022-08-05 20:32 ` paper42
@ 2022-08-05 20:33 ` paper42
  2022-08-05 20:40 ` [PR PATCH] [Updated] " classabbyamp
                   ` (27 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-05 20:33 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 294 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939207720

Comment:
~~That sounds like it's called upstream only if it's a fork and we are cloning void-linux/void-packages which isn't a fork~~ I should learn to read

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (6 preceding siblings ...)
  2022-08-05 20:33 ` paper42
@ 2022-08-05 20:40 ` classabbyamp
  2022-08-05 20:41 ` classabbyamp
                   ` (26 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-05 20:40 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 615 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes



A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 7894 bytes --]

From 025d6a953114c4de946cb9df0bf7ed709b6f7e0e Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
---
 CONTRIBUTING.md | 56 ++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 44 insertions(+), 12 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..a8b5fcb93b0f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,25 +4,45 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
 For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
 
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
+
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
+    # with SSH set up for GitHub (recommended)
     $ git clone git@github.com:<user>/void-packages.git
+    # without SSH set up for GitHub
+    $ git clone https://github.com/<user>/void-packages.git
 
 To keep your forked repository up to date, setup the `upstream` remote to pull in new changes:
 
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged.
+It makes it harder to update your pull request later on and makes it harder to test the changes you have made.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
 You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
@@ -33,26 +53,38 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
+### Updating a template
+
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
+
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
+
+### Committing your changes
+
 When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
 
     $ xlint template
 
 If `xlint` reports any issues, resolve them before committing.
 
-### Committing your changes
-
 Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
 
 * for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
 
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
 If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
 
 `xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
@@ -69,8 +101,8 @@ Your package must build successfully for at least x86, but we recommend trying t
 
     $ ./xbps-src -a armv7l pkg <pkgname>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+When building for a native architecture (`x86_64*`, `i686`), building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
 ### Starting a pull request
 

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (7 preceding siblings ...)
  2022-08-05 20:40 ` [PR PATCH] [Updated] " classabbyamp
@ 2022-08-05 20:41 ` classabbyamp
  2022-08-05 21:10 ` [PR REVIEW] " tranzystorek-io
                   ` (25 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-05 20:41 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 323 bytes --]

New comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#issuecomment-1206848339

Comment:
> Couod we also mention that people should have their commit email added to their github profile?

added something to that effect, not sure on the wording or placement though

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (8 preceding siblings ...)
  2022-08-05 20:41 ` classabbyamp
@ 2022-08-05 21:10 ` tranzystorek-io
  2022-08-05 21:21 ` [PR PATCH] [Updated] " classabbyamp
                   ` (24 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: tranzystorek-io @ 2022-08-05 21:10 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 312 bytes --]

New review comment by tranzystorek-io on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939227076

Comment:
Example commit could include a removal reason for reference, e.g. https://github.com/void-linux/void-packages/commit/3837665503241835bddb73be14d269cf9dbc6020

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (9 preceding siblings ...)
  2022-08-05 21:10 ` [PR REVIEW] " tranzystorek-io
@ 2022-08-05 21:21 ` classabbyamp
  2022-08-05 22:01 ` [PR REVIEW] " Chocimier
                   ` (23 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-05 21:21 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 615 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes



A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 7894 bytes --]

From 8fb274db44df0769441f2cbee882e91956088594 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
---
 CONTRIBUTING.md | 56 ++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 44 insertions(+), 12 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..d16e4e6f4b2a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,25 +4,45 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
 For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
 
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
+
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
+    # with SSH set up for GitHub (recommended)
     $ git clone git@github.com:<user>/void-packages.git
+    # without SSH set up for GitHub
+    $ git clone https://github.com/<user>/void-packages.git
 
 To keep your forked repository up to date, setup the `upstream` remote to pull in new changes:
 
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged.
+It makes it harder to update your pull request later on and makes it harder to test the changes you have made.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
 You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
@@ -33,26 +53,38 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
+### Updating a template
+
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
+
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
+
+### Committing your changes
+
 When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
 
     $ xlint template
 
 If `xlint` reports any issues, resolve them before committing.
 
-### Committing your changes
-
 Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/3837665503241835bddb73be14d269cf9dbc6020)).
 
 * for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
 
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
 If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
 
 `xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
@@ -69,8 +101,8 @@ Your package must build successfully for at least x86, but we recommend trying t
 
     $ ./xbps-src -a armv7l pkg <pkgname>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+When building for a native architecture (`x86_64*`, `i686`), building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
 ### Starting a pull request
 

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (12 preceding siblings ...)
  2022-08-05 22:01 ` Chocimier
@ 2022-08-05 22:01 ` Chocimier
  2022-08-05 22:01 ` Chocimier
                   ` (20 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: Chocimier @ 2022-08-05 22:01 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 235 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939289002

Comment:
... and you need to clone and modify on disk to test the changes you have made anyway.

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (10 preceding siblings ...)
  2022-08-05 21:21 ` [PR PATCH] [Updated] " classabbyamp
@ 2022-08-05 22:01 ` Chocimier
  2022-08-05 22:01 ` Chocimier
                   ` (22 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: Chocimier @ 2022-08-05 22:01 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 204 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939313392

Comment:
`xrevbump` is handy to do non-updates, can mention here

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (11 preceding siblings ...)
  2022-08-05 22:01 ` [PR REVIEW] " Chocimier
@ 2022-08-05 22:01 ` Chocimier
  2022-08-05 22:01 ` Chocimier
                   ` (21 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: Chocimier @ 2022-08-05 22:01 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 254 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939324987

Comment:
> , explain in body separated with empty line from headline

so it explains what aforementioned body is

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (13 preceding siblings ...)
  2022-08-05 22:01 ` Chocimier
@ 2022-08-05 22:01 ` Chocimier
  2022-08-06  3:11 ` [PR PATCH] [Updated] " classabbyamp
                   ` (19 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: Chocimier @ 2022-08-05 22:01 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 309 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939277369

Comment:
Authenticated github https remote requires token expirable in days rather than password, sot not really easier to setup than ssh. Is it worthwhile to recommend?

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (14 preceding siblings ...)
  2022-08-05 22:01 ` Chocimier
@ 2022-08-06  3:11 ` classabbyamp
  2022-08-06  3:33 ` classabbyamp
                   ` (18 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06  3:11 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 615 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes



A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 10882 bytes --]

From e0b212c9f45e9791ea3f1dab8a96651a8ae973a2 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL
---
 CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 58 insertions(+), 26 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..45a8f1a301e6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,15 +4,16 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
-For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
+For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com) with [SSH set up](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
 
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
@@ -23,9 +24,24 @@ To keep your forked repository up to date, setup the `upstream` remote to pull i
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged, because you will need to clone the repo anyways to edit and test your changes.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
-You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
+You can use the helper tool `xnew`, from the [xtools](https://github.com/leahneukirchen/xtools) package, to create new templates:
 
     $ xnew pkgname subpkg1 subpkg2 ...
 
@@ -33,44 +49,60 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
-When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+### Updating a template
 
-    $ xlint template
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
 
-If `xlint` reports any issues, resolve them before committing.
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
 
 ### Committing your changes
 
-Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
+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:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+    $ ./xbps-src pkg <pkgname>
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+    $ ./xbps-src -a armv7l pkg <pkgname>
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+When building for a native architecture (`x86_64*`, `i686`), building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
-* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
 
-If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+    $ xlint template
 
-`xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
+If `xlint` reports any issues, resolve them before committing.
 
-    $ xbump <pkgname> <git commit options>
+Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-`xbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-After committing your changes, please check that the package builds successfully. From the top level directory of your local copy of the `void-packages` repository, run:
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-    $ ./xbps-src pkg <pkgname>
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/3837665503241835bddb73be14d269cf9dbc6020)).
 
-    $ ./xbps-src -a armv7l pkg <pkgname>
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
+If you want to describe your changes in more detail, explain in the commit body (separated from the first line with a blank line) ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+
+`xbump`, available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a new or updated package:
+
+    $ xbump <pkgname> <git commit options>
+
+`xrevbump`, also available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a template modification for a package:
+
+    $ xrevbump '<message>' <pkgname>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+`xbump` and `xrevbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
 
 ### Starting a pull request
 
@@ -113,7 +145,7 @@ A more powerful way of modifying commits than using `git commit --amend` is with
 Alternatively, if there are issues with your git history, you can make another branch and push it to the existing PR:
 
     $ git checkout master -b <attempt2>
-    $ # do changes anew
+    # do changes anew
     $ git push -f <fork> <attempt2>:<branch-of-pr>
 
 #### Closing the pull request

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (15 preceding siblings ...)
  2022-08-06  3:11 ` [PR PATCH] [Updated] " classabbyamp
@ 2022-08-06  3:33 ` classabbyamp
  2022-08-06  3:38 ` classabbyamp
                   ` (17 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06  3:33 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 732 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL

A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 10886 bytes --]

From a126197c58e6a6bb016d490d02757df2beee7e16 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL
---
 CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 58 insertions(+), 26 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..7866b7d4fb35 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,15 +4,16 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
-For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
+For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com) with [SSH set up](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
 
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
@@ -23,9 +24,24 @@ To keep your forked repository up to date, setup the `upstream` remote to pull i
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged, because you will need to clone the repo anyways to edit and test your changes.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
-You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
+You can use the helper tool `xnew`, from the [xtools](https://github.com/leahneukirchen/xtools) package, to create new templates:
 
     $ xnew pkgname subpkg1 subpkg2 ...
 
@@ -33,44 +49,60 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
-When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+### Updating a template
 
-    $ xlint template
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
 
-If `xlint` reports any issues, resolve them before committing.
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
 
 ### Committing your changes
 
-Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
+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:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+    $ ./xbps-src pkg <pkgname>
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+    $ ./xbps-src -a armv7l pkg <pkgname>
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+When building for a native architecture (`x86_64*`, `i686`), building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
-* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
 
-If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+    $ xlint template
 
-`xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
+If `xlint` reports any issues, resolve them before committing.
 
-    $ xbump <pkgname> <git commit options>
+Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-`xbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-After committing your changes, please check that the package builds successfully. From the top level directory of your local copy of the `void-packages` repository, run:
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-    $ ./xbps-src pkg <pkgname>
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/3837665503241835bddb73be14d269cf9dbc6020)).
 
-    $ ./xbps-src -a armv7l pkg <pkgname>
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
+If you want to describe your changes in more detail, explain in the commit body (separated from the first line with a blank line) ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+
+`xbump`, available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a new or updated package:
+
+    $ xbump <pkgname> <git commit options>
+
+`xrevbump`, also available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a template modification for a package:
+
+    $ xrevbump '<message>' <pkgnames...>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+`xbump` and `xrevbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
 
 ### Starting a pull request
 
@@ -113,7 +145,7 @@ A more powerful way of modifying commits than using `git commit --amend` is with
 Alternatively, if there are issues with your git history, you can make another branch and push it to the existing PR:
 
     $ git checkout master -b <attempt2>
-    $ # do changes anew
+    # do changes anew
     $ git push -f <fork> <attempt2>:<branch-of-pr>
 
 #### Closing the pull request

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (16 preceding siblings ...)
  2022-08-06  3:33 ` classabbyamp
@ 2022-08-06  3:38 ` classabbyamp
  2022-08-06  6:17 ` [PR REVIEW] " tranzystorek-io
                   ` (16 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06  3:38 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 732 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL

A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 11967 bytes --]

From b9da74b419026d47d5b1277e6ac7bf3c1f9660ca Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL
---
 CONTRIBUTING.md | 86 +++++++++++++++++++++++++++++++++----------------
 1 file changed, 59 insertions(+), 27 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..2aa74c48578c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,15 +4,16 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
-For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
+For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com) with [SSH set up](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
 
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
@@ -23,9 +24,24 @@ To keep your forked repository up to date, setup the `upstream` remote to pull i
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged, because you will need to clone the repo anyways to edit and test your changes.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
-You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
+You can use the helper tool `xnew`, from the [xtools](https://github.com/leahneukirchen/xtools) package, to create new templates:
 
     $ xnew pkgname subpkg1 subpkg2 ...
 
@@ -33,44 +49,60 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
-When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+### Updating a template
 
-    $ xlint template
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
 
-If `xlint` reports any issues, resolve them before committing.
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
 
 ### Committing your changes
 
-Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
+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:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+    $ ./xbps-src pkg <pkgname>
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+    $ ./xbps-src -a armv7l pkg <pkgname>
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+When building for a native architecture (`x86_64*`, `i686`), building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
-* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
 
-If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+    $ xlint template
 
-`xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
+If `xlint` reports any issues, resolve them before committing.
 
-    $ xbump <pkgname> <git commit options>
+Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-`xbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-After committing your changes, please check that the package builds successfully. From the top level directory of your local copy of the `void-packages` repository, run:
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-    $ ./xbps-src pkg <pkgname>
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/3837665503241835bddb73be14d269cf9dbc6020)).
 
-    $ ./xbps-src -a armv7l pkg <pkgname>
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
+If you want to describe your changes in more detail, explain in the commit body (separated from the first line with a blank line) ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+
+`xbump`, available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a new or updated package:
+
+    $ xbump <pkgname> <git commit options>
+
+`xrevbump`, also available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a template modification for a package:
+
+    $ xrevbump '<message>' <pkgnames...>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+`xbump` and `xrevbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
 
 ### Starting a pull request
 
@@ -113,7 +145,7 @@ A more powerful way of modifying commits than using `git commit --amend` is with
 Alternatively, if there are issues with your git history, you can make another branch and push it to the existing PR:
 
     $ git checkout master -b <attempt2>
-    $ # do changes anew
+    # do changes anew
     $ git push -f <fork> <attempt2>:<branch-of-pr>
 
 #### Closing the pull request
@@ -123,7 +155,7 @@ Once you have applied all requested changes, the reviewers will merge your reque
 If the pull request becomes inactive for some days, the reviewers may or may not warn you when they are about to close it.
 If it stays inactive further, it will be closed.
 
-Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included.
+Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, [mark it as a draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft), or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included.
 
 #### Publishing the package
 

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (17 preceding siblings ...)
  2022-08-06  3:38 ` classabbyamp
@ 2022-08-06  6:17 ` tranzystorek-io
  2022-08-06  6:27 ` classabbyamp
                   ` (15 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: tranzystorek-io @ 2022-08-06  6:17 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 226 bytes --]

New review comment by tranzystorek-io on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939490426

Comment:
```suggestion
    $ gh repo fork --clone void-linux/void-packages
```

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (18 preceding siblings ...)
  2022-08-06  6:17 ` [PR REVIEW] " tranzystorek-io
@ 2022-08-06  6:27 ` classabbyamp
  2022-08-06  6:32 ` tranzystorek-io
                   ` (14 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06  6:27 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 290 bytes --]

New review comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939491313

Comment:
I'm aware of that, but I think keeping it as two commands is good because it's clearer what someone who already has forked the repo can do

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (19 preceding siblings ...)
  2022-08-06  6:27 ` classabbyamp
@ 2022-08-06  6:32 ` tranzystorek-io
  2022-08-06  6:37 ` classabbyamp
                   ` (13 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: tranzystorek-io @ 2022-08-06  6:32 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 272 bytes --]

New review comment by tranzystorek-io on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939491766

Comment:
Ah, that makes sense. But, as a side note, the one-liner would also clone the fork even if it's already been created.

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (20 preceding siblings ...)
  2022-08-06  6:32 ` tranzystorek-io
@ 2022-08-06  6:37 ` classabbyamp
  2022-08-06  6:37 ` classabbyamp
                   ` (12 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06  6:37 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 319 bytes --]

New review comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939492149

Comment:
does it properly handle having forks in multiple namespaces? e.g. if i had classabbyamp/void-packages and foobar-org/void-packages, will it show a picker or something?

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (21 preceding siblings ...)
  2022-08-06  6:37 ` classabbyamp
@ 2022-08-06  6:37 ` classabbyamp
  2022-08-06  6:48 ` tranzystorek-io
                   ` (11 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06  6:37 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 366 bytes --]

New review comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939492149

Comment:
does it properly handle having forks in multiple namespaces (or creating a new fork if one already exists)? e.g. if i had classabbyamp/void-packages and foobar-org/void-packages, will it show a picker or something?

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (22 preceding siblings ...)
  2022-08-06  6:37 ` classabbyamp
@ 2022-08-06  6:48 ` tranzystorek-io
  2022-08-06  7:00 ` Chocimier
                   ` (10 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: tranzystorek-io @ 2022-08-06  6:48 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 308 bytes --]

New review comment by tranzystorek-io on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939493130

Comment:
I did a quick test and the answer is no. It only takes into account the fork in the main authorized account (classabbyamp/void-packages in your example).

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (23 preceding siblings ...)
  2022-08-06  6:48 ` tranzystorek-io
@ 2022-08-06  7:00 ` Chocimier
  2022-08-06 14:25 ` [PR PATCH] [Updated] " classabbyamp
                   ` (9 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: Chocimier @ 2022-08-06  7:00 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 183 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939494154

Comment:
building as root is unsupported ;)

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (24 preceding siblings ...)
  2022-08-06  7:00 ` Chocimier
@ 2022-08-06 14:25 ` classabbyamp
  2022-08-06 14:28 ` [PR REVIEW] " classabbyamp
                   ` (8 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06 14:25 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 732 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL

A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 11571 bytes --]

From 04d26ea30d60dd3fc3a2edef5e51bb838986e373 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL
---
 CONTRIBUTING.md | 84 ++++++++++++++++++++++++++++++++++---------------
 1 file changed, 58 insertions(+), 26 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..b2a0e21b63ba 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,15 +4,16 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
-For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
+For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com) with [SSH set up](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
 
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
@@ -23,9 +24,24 @@ To keep your forked repository up to date, setup the `upstream` remote to pull i
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged, because you will need to clone the repo anyways to edit and test your changes.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
-You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
+You can use the helper tool `xnew`, from the [xtools](https://github.com/leahneukirchen/xtools) package, to create new templates:
 
     $ xnew pkgname subpkg1 subpkg2 ...
 
@@ -33,44 +49,60 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
-When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+### Updating a template
 
-    $ xlint template
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
 
-If `xlint` reports any issues, resolve them before committing.
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
 
 ### Committing your changes
 
-Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
+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:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+    $ ./xbps-src pkg <pkgname>
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+    $ ./xbps-src -a armv7l pkg <pkgname>
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+When building for a native architecture (`x86_64*`, `i686`), building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+New packages and updates will not be accepted unless they have been runtime tested.
 
-* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
 
-If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+    $ xlint template
 
-`xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
+If `xlint` reports any issues, resolve them before committing.
 
-    $ xbump <pkgname> <git commit options>
+Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-`xbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
 
-After committing your changes, please check that the package builds successfully. From the top level directory of your local copy of the `void-packages` repository, run:
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
 
-    $ ./xbps-src pkg <pkgname>
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
-Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/3837665503241835bddb73be14d269cf9dbc6020)).
 
-    $ ./xbps-src -a armv7l pkg <pkgname>
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78))
+
+If you want to describe your changes in more detail, explain in the commit body (separated from the first line with a blank line) ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+
+`xbump`, available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a new or updated package:
+
+    $ xbump <pkgname> <git commit options>
+
+`xrevbump`, also available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a template modification for a package:
+
+    $ xrevbump '<message>' <pkgnames...>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+`xbump` and `xrevbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
 
 ### Starting a pull request
 
@@ -123,7 +155,7 @@ Once you have applied all requested changes, the reviewers will merge your reque
 If the pull request becomes inactive for some days, the reviewers may or may not warn you when they are about to close it.
 If it stays inactive further, it will be closed.
 
-Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included.
+Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, [mark it as a draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft), or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included.
 
 #### Publishing the package
 

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (25 preceding siblings ...)
  2022-08-06 14:25 ` [PR PATCH] [Updated] " classabbyamp
@ 2022-08-06 14:28 ` classabbyamp
  2022-08-06 15:58 ` paper42
                   ` (7 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06 14:28 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 280 bytes --]

New review comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939534917

Comment:
ok, I think I prefer the two-step method then. if someone is experienced with github-cli, maybe they can use the one-step method

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (26 preceding siblings ...)
  2022-08-06 14:28 ` [PR REVIEW] " classabbyamp
@ 2022-08-06 15:58 ` paper42
  2022-08-06 15:58 ` paper42
                   ` (6 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-06 15:58 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 215 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939544347

Comment:
native isn't always x86_64* and i686, could we somehow mention this?

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (28 preceding siblings ...)
  2022-08-06 15:58 ` paper42
@ 2022-08-06 15:58 ` paper42
  2022-08-06 15:58 ` paper42
                   ` (4 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-06 15:58 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 265 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939544445

Comment:
Because this is right after mentioning the check phase, some people might thing runtime testing is just running check.

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (27 preceding siblings ...)
  2022-08-06 15:58 ` paper42
@ 2022-08-06 15:58 ` paper42
  2022-08-06 15:58 ` paper42
                   ` (5 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-06 15:58 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 386 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939544193

Comment:
```suggestion
Your package must build successfully for at least x86, but we recommend also trying a cross-build for armv6* e.g.:
```
armv6 often has more issues than armv7 and we should mention this is a cross build to prevent confusion

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR REVIEW] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (29 preceding siblings ...)
  2022-08-06 15:58 ` paper42
@ 2022-08-06 15:58 ` paper42
  2022-08-06 16:45 ` [PR PATCH] [Updated] " classabbyamp
                   ` (3 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: paper42 @ 2022-08-06 15:58 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 394 bytes --]

New review comment by paper42 on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#discussion_r939544790

Comment:
Most of these examples are very old and in some cases, the templates they modify would be considered wrong (lint, different variables, etc.). New people might try to copy things they see in these templates, so we should try to find newer examples.

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Updated] CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (30 preceding siblings ...)
  2022-08-06 15:58 ` paper42
@ 2022-08-06 16:45 ` classabbyamp
  2022-08-10 19:45 ` classabbyamp
                   ` (2 subsequent siblings)
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-06 16:45 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 732 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages contrib-updating
https://github.com/void-linux/void-packages/pull/38491

CONTRIBUTING.md: add info about updating templates, misc other changes
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL

A patch file from https://github.com/void-linux/void-packages/pull/38491.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contrib-updating-38491.patch --]
[-- Type: text/x-diff, Size: 11557 bytes --]

From 752b408b72ff32aa9e467087ac4bc9a8cf3a64d0 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Fri, 5 Aug 2022 16:08:58 -0400
Subject: [PATCH] CONTRIBUTING.md: add info about updating templates, misc
 other changes

- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL
- update example commits
---
 CONTRIBUTING.md | 82 +++++++++++++++++++++++++++++++++----------------
 1 file changed, 56 insertions(+), 26 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3f33aeb1d974..b21b9acdc5eb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,15 +4,16 @@ void-packages is the backbone of the Void Linux distribution. It contains all th
 
 This document describes how you, as a contributor, can help with adding packages, correcting bugs and adding features to void-packages.
 
-## Getting your packages into Void by yourself
+## Creating, updating, and modifying packages in Void by yourself
 
-If you really want to get a package into Void Linux, we recommend you package it yourself.
+If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself.
 
 We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
-There's also a [manual for xbps-src](./README.md), which is used
-to build package files from templates.
+There's also a [manual for xbps-src](./README.md), which is used to build package files from templates.
 
-For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
+For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com) with [SSH set up](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+
+You should also [set the email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) on your GitHub account and in git so your commits are associated with your GitHub account properly.
 
 To get started, [fork](https://help.github.com/articles/fork-a-repo) the void-linux `void-packages` git repository on GitHub and clone it:
 
@@ -23,9 +24,24 @@ To keep your forked repository up to date, setup the `upstream` remote to pull i
     $ git remote add upstream https://github.com/void-linux/void-packages.git
     $ git pull --rebase upstream master
 
+This can also be done with the `github-cli` tool:
+
+    $ gh repo fork void-linux/void-packages
+    $ gh repo clone <user>/void-packages
+
+This automatically sets up the `upstream` remote, so `git pull --rebase upstream master` can still be used to keep your fork up-to-date.
+
+Using the GitHub web editor for making changes is strongly discouraged, because you will need to clone the repo anyways to edit and test your changes.
+
+using the the `master` branch of your fork for contributing is also strongly discouraged.
+It can cause many issues with updating your pull request (also called a PR), and having multiple PRs open at once.
+To create a new branch:
+
+    $ git checkout master -b <a-descriptive-name>
+
 ### Creating a new template
 
-You can use the helper tool `xnew`, from the [xtools](https://github.com/chneukirchen/xtools) package, to create new templates:
+You can use the helper tool `xnew`, from the [xtools](https://github.com/leahneukirchen/xtools) package, to create new templates:
 
     $ xnew pkgname subpkg1 subpkg2 ...
 
@@ -33,44 +49,58 @@ Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `
 
 For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
-When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
+### Updating a template
 
-    $ xlint template
+At minimum, a template update will consist of changing `version` and `checksum`, if there was an upstream version change, and/or `revision`, if a template-specific change (e.g. patch, correction, etc.) is needed.
+Other changes to the template may be needed depending on what changes the upstream has made.
 
-If `xlint` reports any issues, resolve them before committing.
+The checksum can be updated automatically with the `xgensum` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
+
+    $ xgensum -i <pkgname>
 
 ### Committing your changes
 
-Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
+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:
 
-* for new packages, use ```New package: <pkgname>-<version>``` ([example](https://github.com/void-linux/void-packages/commit/176d9655429188aac10cd229827f99b72982ab10)).
+    $ ./xbps-src pkg <pkgname>
 
-* for package updates, use ```<pkgname>: update to <version>.``` ([example](https://github.com/void-linux/void-packages/commit/b6b82dcbd4aeea5fc37a32e4b6a8dd8bd980d5a3)).
+Your package must build successfully for at least x86, but we recommend also trying a cross-build for armv6l* as well, e.g.:
 
-* for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
+    $ ./xbps-src -a armv6l pkg <pkgname>
 
-* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+When building for `x86_64*` or `i686`, building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in `etc/conf` (to run the check phase) is strongly encouraged.
+Also, new packages and updates will not be accepted unless they have been runtime tested by installing and running the package.
 
-* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/leahneukirchen/xtools) package:
 
-If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+    $ xlint template
 
-`xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
+If `xlint` reports any issues, resolve them before committing.
 
-    $ xbump <pkgname> <git commit options>
+Once you have made and verified your changes to the package template and/or other files, make one commit per package (including all changes to its sub-packages). Each commit message should have one of the following formats:
 
-`xbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
+* for new packages, use `New package: <pkgname>-<version>` ([example](https://github.com/void-linux/void-packages/commit/8ed8d41c40bf6a82cf006c7e207e05942c15bff8)).
 
-After committing your changes, please check that the package builds successfully. From the top level directory of your local copy of the `void-packages` repository, run:
+* for package updates, use `<pkgname>: update to <version>.` ([example](https://github.com/void-linux/void-packages/commit/c92203f1d6f33026ae89f3e4c1012fb6450bbac1)).
 
-    $ ./xbps-src pkg <pkgname>
+* for template modifications without a version change, use `<pkgname>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/ff39c912d412717d17232de9564f659b037e95b5)).
+
+* for package removals, use `<pkgname>: remove package` and include the removal reason in the commit body ([example](https://github.com/void-linux/void-packages/commit/4322f923bdf5d4e0eb36738d4f4717d72d0a0ca4)).
+
+* for changes to any other file, use `<filename>: <reason>` ([example](https://github.com/void-linux/void-packages/commit/e00bea014c36a70d60acfa1758514b0c7cb0627d),
+  [example](https://github.com/void-linux/void-packages/commit/93bf159ce10d8e474da5296e5bc98350d00c6c82), [example](https://github.com/void-linux/void-packages/commit/dc62938c67b66a7ff295eab541dc37b92fb9fb78), [example](https://github.com/void-linux/void-packages/commit/e52317e939d41090562cf8f8131a68772245bdde))
+
+If you want to describe your changes in more detail, explain in the commit body (separated from the first line with a blank line) ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+
+`xbump`, available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a new or updated package:
+
+    $ xbump <pkgname> <git commit options>
 
-Your package must build successfully for at least x86, but we recommend trying to build for armv* as well, e.g.:
+`xrevbump`, also available in the [xtools](https://github.com/leahneukirchen/xtools) package, can be used to commit a template modification for a package:
 
-    $ ./xbps-src -a armv7l pkg <pkgname>
+    $ xrevbump '<message>' <pkgnames...>
 
-Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
-New packages will not be accepted unless they have been runtime tested.
+`xbump` and `xrevbump` will use `git commit` to commit the changes with the appropriate commit message. For more fine-grained control over the commit, specific options can be passed to `git commit` by adding them after the package name.
 
 ### Starting a pull request
 
@@ -123,7 +153,7 @@ Once you have applied all requested changes, the reviewers will merge your reque
 If the pull request becomes inactive for some days, the reviewers may or may not warn you when they are about to close it.
 If it stays inactive further, it will be closed.
 
-Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included.
+Please abstain from temporarily closing a pull request while revising the templates. Instead, leave a comment on the PR describing what still needs work, [mark it as a draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft), or add "[WIP]" to the PR title. Only close your pull request if you're sure you don't want your changes to be included.
 
 #### Publishing the package
 

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (31 preceding siblings ...)
  2022-08-06 16:45 ` [PR PATCH] [Updated] " classabbyamp
@ 2022-08-10 19:45 ` classabbyamp
  2022-08-12 16:48 ` classabbyamp
  2022-08-12 16:48 ` [PR PATCH] [Merged]: " classabbyamp
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-10 19:45 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 178 bytes --]

New comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#issuecomment-1211191223

Comment:
anyone have any other comments?

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (32 preceding siblings ...)
  2022-08-10 19:45 ` classabbyamp
@ 2022-08-12 16:48 ` classabbyamp
  2022-08-12 16:48 ` [PR PATCH] [Merged]: " classabbyamp
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-12 16:48 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 180 bytes --]

New comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/38491#issuecomment-1213318705

Comment:
with no other objections, merging

^ permalink raw reply	[flat|nested] 36+ messages in thread

* Re: [PR PATCH] [Merged]: CONTRIBUTING.md: add info about updating templates, misc other changes
  2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
                   ` (33 preceding siblings ...)
  2022-08-12 16:48 ` classabbyamp
@ 2022-08-12 16:48 ` classabbyamp
  34 siblings, 0 replies; 36+ messages in thread
From: classabbyamp @ 2022-08-12 16:48 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 557 bytes --]

There's a merged pull request on the void-packages repository

CONTRIBUTING.md: add info about updating templates, misc other changes
https://github.com/void-linux/void-packages/pull/38491

Description:
- a few small formatting/grammar changes/corrections
- document cloning with https, github-cli
- document using non-fork-master branch for changes
- document not using web ui for commiting
- add example commits for non-package changes
- add xrevbump
- reorder so testing build locally is before committing (more chronological)
- update xtools URL

^ permalink raw reply	[flat|nested] 36+ messages in thread

end of thread, other threads:[~2022-08-12 16:48 UTC | newest]

Thread overview: 36+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-08-05 20:15 [PR PATCH] CONTRIBUTING.md: add info about updating templates, misc other changes classabbyamp
2022-08-05 20:27 ` [PR REVIEW] " paper42
2022-08-05 20:27 ` paper42
2022-08-05 20:27 ` paper42
2022-08-05 20:28 ` classabbyamp
2022-08-05 20:31 ` paper42
2022-08-05 20:32 ` paper42
2022-08-05 20:33 ` paper42
2022-08-05 20:40 ` [PR PATCH] [Updated] " classabbyamp
2022-08-05 20:41 ` classabbyamp
2022-08-05 21:10 ` [PR REVIEW] " tranzystorek-io
2022-08-05 21:21 ` [PR PATCH] [Updated] " classabbyamp
2022-08-05 22:01 ` [PR REVIEW] " Chocimier
2022-08-05 22:01 ` Chocimier
2022-08-05 22:01 ` Chocimier
2022-08-05 22:01 ` Chocimier
2022-08-06  3:11 ` [PR PATCH] [Updated] " classabbyamp
2022-08-06  3:33 ` classabbyamp
2022-08-06  3:38 ` classabbyamp
2022-08-06  6:17 ` [PR REVIEW] " tranzystorek-io
2022-08-06  6:27 ` classabbyamp
2022-08-06  6:32 ` tranzystorek-io
2022-08-06  6:37 ` classabbyamp
2022-08-06  6:37 ` classabbyamp
2022-08-06  6:48 ` tranzystorek-io
2022-08-06  7:00 ` Chocimier
2022-08-06 14:25 ` [PR PATCH] [Updated] " classabbyamp
2022-08-06 14:28 ` [PR REVIEW] " classabbyamp
2022-08-06 15:58 ` paper42
2022-08-06 15:58 ` paper42
2022-08-06 15:58 ` paper42
2022-08-06 15:58 ` paper42
2022-08-06 16:45 ` [PR PATCH] [Updated] " classabbyamp
2022-08-10 19:45 ` classabbyamp
2022-08-12 16:48 ` classabbyamp
2022-08-12 16:48 ` [PR PATCH] [Merged]: " classabbyamp

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).