From 79a5f67d3fd5db3a454e2da288e6a441133a5394 Mon Sep 17 00:00:00 2001 From: classabbyamp Date: Fri, 12 Aug 2022 13:06:20 -0400 Subject: [PATCH 1/3] Manual.md, CONTRIBUTING.md: move quality requirements to CONTRIBUTING rename to Package Requirements --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ Manual.md | 33 --------------------------------- 2 files changed, 23 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b21b9acdc5eb..ab24ede1f341 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,29 @@ 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. +## Package Requirements + +To be included in the Void repository, software must meet at least one of the following requirements. +Exceptions to the list are possible, and might be accepted, but are extremely unlikely. +If you believe you have an exception, start a PR and make an argument for why that particular piece of software, +while not meeting any of the following requirements, is a good candidate for the Void packages system. + +1. **System**: The software should be installed system-wide, not per-user. + +1. **Compiled**: The software needs to be compiled before being used, even if it is software that is not needed by the whole system. + +1. **Required**: Another package either within the repository or pending inclusion requires the package. + +In particular, new themes are highly unlikely to be accepted. +Simple shell scripts are unlikely to be accepted unless they provide considerable value to a broad user base. +New fonts may be accepted if they provide value beyond aesthetics (e.g. they contain glyphs for a script missing in already packaged fonts). + +Browser forks, including those based on Chromium and Firefox, are generally not accepted. +Such forks require heavy patching, maintenance and hours of build time. + +Software need to be used in version announced by authors as ready to use by the general public - usually called releases. +Betas, arbitrary VCS revisions, templates using tip of development branch taken at build time and releases created by the package maintainer won't be accepted. + ## Creating, updating, and modifying packages in Void by yourself If you really want to get a new package or package update into Void Linux, we recommend you contribute it yourself. diff --git a/Manual.md b/Manual.md index 3b0d85e78abc..f22e878277ab 100644 --- a/Manual.md +++ b/Manual.md @@ -6,7 +6,6 @@ packages for XBPS, the `Void Linux` native packaging system. *Table of Contents* * [Introduction](#Introduction) - * [Quality Requirements](#quality_requirements) * [Package build phases](#buildphase) * [Package naming conventions](#namingconventions) * [Libraries](#libs) @@ -124,38 +123,6 @@ If everything went fine after running a binary package named `foo-1.0_1..xbps` will be generated in the local repository `hostdir/binpkgs`. - -### Quality Requirements - -To be included in the Void repository, software must meet at least one -of the following requirements. Exceptions to the list are possible, -and might be accepted, but are extremely unlikely. If you believe you have an -exception, start a PR and make an argument for why that particular piece of -software, while not meeting any of the following requirements, is a good candidate for -the Void packages system. - -1. System: The software should be installed system-wide, not per-user. - -1. Compiled: The software needs to be compiled before being used, even if it is - software that is not needed by the whole system. - -1. Required: Another package either within the repository or pending inclusion - requires the package. - -In particular, new themes are highly unlikely to be accepted. Simple shell -scripts are unlikely to be accepted unless they provide considerable value to a -broad user base. New fonts may be accepted if they provide value beyond -aesthetics (e.g. they contain glyphs for a script missing in already packaged -fonts). - -Browser forks, including those based on Chromium and Firefox, are generally not -accepted. Such forks require heavy patching, maintenance and hours of build time. - -Software need to be used in version announced by authors as ready to use by -the general public - usually called releases. Betas, arbitrary VCS revisions, -templates using tip of development branch taken at build time and releases -created by the package maintainer won't be accepted. - ### Package build phases From 20699d329fb9b3d69b7beb3f21a1f0798ab65da9 Mon Sep 17 00:00:00 2001 From: classabbyamp Date: Fri, 12 Aug 2022 13:07:05 -0400 Subject: [PATCH 2/3] .github/ISSUE_TEMPLATE/pkg-request.yml: update pkg reqs url --- .github/ISSUE_TEMPLATE/pkg-request.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pkg-request.yml b/.github/ISSUE_TEMPLATE/pkg-request.yml index 1dbbe572d069..a50049efc108 100644 --- a/.github/ISSUE_TEMPLATE/pkg-request.yml +++ b/.github/ISSUE_TEMPLATE/pkg-request.yml @@ -36,9 +36,9 @@ body: - id: quality type: dropdown attributes: - label: Does the requested package meet the quality requirements? + label: Does the requested package meet the package requirements? description: | - See [Manual.md](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality_requirements) for details + See [CONTRIBUTING.md](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#package-requirements) for details multiple: true options: - System @@ -51,7 +51,7 @@ body: attributes: label: Is the requested package released? description: | - See [Manual.md](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality_requirements) for details + See [CONTRIBUTING.md](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#package-requirements) for details options: - "Yes" - "No" From 389fddaf84e79086dbf8feee5737b1e3196cbcf8 Mon Sep 17 00:00:00 2001 From: classabbyamp Date: Fri, 12 Aug 2022 13:11:55 -0400 Subject: [PATCH 3/3] .github/pull_request_template.md: update pkg reqs url --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8a9e2348494d..57f7cc96d84e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,7 @@