From 24140e0260c38e57e5d1c9ba4f2fa88451d2dcf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Rolim?= Date: Mon, 4 May 2020 20:21:45 -0300 Subject: [PATCH 1/3] CONTRIBUTING.md: add commit examples and expl. to PR process - Add commit examples for package removal and shlibs modifications - Explain the PR process, specially when related to soname bumps - Explain [ci skip] - Add testing requirements --- CONTRIBUTING.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0490b5f11c2..0bbae36a014 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,8 +43,20 @@ Once you have built your template file or files, the commit message should have * for template modifications without a version change, use ```: ``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)). +* for package removals, use ```: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)). + +* for `common/shlibs` modifications, use `common/shlibs: ` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)). + 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)). +Pull requests are automatically submitted for Continuous Integration (CI) testing to ensure packages build on various combinations of libc and architecture. +Packages that take longer than 50 minutes to build (for example, Firefox or the Linux kernel) will fail CI and should include `[ci skip]` in the last line of the last commit message in the PR to avoid wasting CI builder time. +Use your best judgment on build times based on your local building experience. If you skip CI when submitting a PR, please build and cross-build for a variety of architectures locally, with both glibc and musl, and note your local results in PR comments. +Make sure to cover 64-bit and 32-bit architectures. + +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. + For further information, please consult the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md). `xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package: @@ -69,8 +81,8 @@ Once you have successfully built the package, you can start a pull request. Most pull requests should only contain a single package and dependencies which are not part of void-packages yet. -If you make updates to packages containing a soname bump you also need to revbump all packages that are dependant. Those -packages should also be part of the same pull request. +If you make updates to packages containing a soname bump, you also need to update `common/shlibs` and revbump all packages that are dependant. +There should be a commit for each package revbump, and those commits should be part of the same pull request. When you make changes to your pull request, please *do not close and reopen your pull request*. Instead, just forcibly git push, overwriting any old commits. Closing and opening your pull requests repeatedly spams the Void maintainers. From 24a99d5395b8c48d2e92c976f785ac81ad3798f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Rolim?= Date: Mon, 4 May 2020 20:29:38 -0300 Subject: [PATCH 2/3] CONTRIBUTING.md: use local links instead of GH ones --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bbae36a014..a38751f55ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,9 +8,8 @@ This document describes how you, as a contributor, can help with adding packages If you really want to get a package into Void Linux, we recommend you package it yourself. -We provide a [comprehensive Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md) -on how to create new packages. There's also a -[manual for xbps-src](https://github.com/void-linux/void-packages/blob/master/README.md), which is used +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. For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com). @@ -25,7 +24,7 @@ You can use the helper tool `xnew`, from the [xtools](https://github.com/chneuki Templates must have the name `void-packages/srcpkgs//template`, where `pkgname` is the same as the `pkgname` variable in the template. -For deeper insights on the contents of template files, please read the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples. +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: From 572341659e4c4ed758b246b53845a23504bff11b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Rolim?= Date: Wed, 8 Jul 2020 16:40:46 -0300 Subject: [PATCH 3/3] README, Manual: use local links for files in repo. --- Manual.md | 5 ++--- README.md | 6 ++---- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/Manual.md b/Manual.md index 10082b68da5..71246910a12 100644 --- a/Manual.md +++ b/Manual.md @@ -1963,9 +1963,8 @@ Fork the voidlinux `void-packages` git repository on github and clone it: $ git clone git@github.com:/void-packages.git -See [CONTRIBUTING.md](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md) -for information on how to format your commits and other tips for -contributing. +See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to format your +commits and other tips for contributing. Once you've made changes to your `forked` repository you can submit a github pull request; see https://help.github.com/articles/fork-a-repo for more information. diff --git a/README.md b/README.md index 7cb3895e6f2..fe85e3f20eb 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,8 @@ The included `xbps-src` script will fetch and compile the sources, and install i files into a `fake destdir` to generate XBPS binary packages that can be installed or queried through the `xbps-install(1)` and `xbps-query(1)` utilities, respectively. -See [Contributing](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md) -for a general overview of how to contribute and the -[Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md) -for details of how to create source packages. +See [Contributing](./CONTRIBUTING.md) for a general overview of how to contribute and the +[Manual](./Manual.md) for details of how to create source packages. ### Table of Contents