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

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).