From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id E1F1E158088 for ; Fri, 4 Feb 2022 11:44:32 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 256742BC050; Fri, 4 Feb 2022 11:44:32 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id F1AAD2BC04F for ; Fri, 4 Feb 2022 11:44:31 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 9B052343305 for ; Fri, 4 Feb 2022 11:44:30 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id E83AA2CE for ; Fri, 4 Feb 2022 11:44:27 +0000 (UTC) From: "Florian Schmaus" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Florian Schmaus" Message-ID: <1643789468.9a95bef60eb78cba7f8e8c6b88476f009721fb4f.flow@gentoo> Subject: [gentoo-commits] repo/proj/guru:master commit in: / X-VCS-Repository: repo/proj/guru X-VCS-Files: CONTRIBUTING.md X-VCS-Directories: / X-VCS-Committer: flow X-VCS-Committer-Name: Florian Schmaus X-VCS-Revision: 9a95bef60eb78cba7f8e8c6b88476f009721fb4f X-VCS-Branch: master Date: Fri, 4 Feb 2022 11:44:27 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 34297ce9-3fa8-40c0-830d-9a23d2329c93 X-Archives-Hash: d4728755aecf7afc59bb336f8fb6d073 commit: 9a95bef60eb78cba7f8e8c6b88476f009721fb4f Author: Anna (cybertailor) Vyalkova sysrq in> AuthorDate: Wed Feb 2 08:05:43 2022 +0000 Commit: Florian Schmaus gentoo org> CommitDate: Wed Feb 2 08:11:08 2022 +0000 URL: https://gitweb.gentoo.org/repo/proj/guru.git/commit/?id=9a95bef6 CONTRIBUTING.md: ebuild testing Signed-off-by: Anna (cybertailor) Vyalkova sysrq.in> CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 108da9e93..456282084 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,6 +84,12 @@ Running `repoman -dx full` in the directory your ebuild is in will preform some Pkgcheck does even more checks than repoman. While it is good practice to make repoman as happy as possible, it is not necessary to fix *every* issue that pkgcheck reports. Because pkgcheck is *very* strict. That being said, pkgcheck is a very useful tool to perfect your ebuilds. +- #### Establish your package testing workflow + +There are [make.conf flags](https://wiki.gentoo.org/wiki/Package_testing#make.conf_.26_test.conf) you might want to set to enable more QA checks. + +The [app-portage/iwdevtools](https://github.com/ionenwks/iwdevtools) package contains scripts that help with ebuild development: finding incorrect dependencies, detectng [ABI changes](https://devmanual.gentoo.org/general-concepts/slotting/index.html#abi-breakage) etc. + - #### Tests and documentation for Python packages. Many Python packages have tests and documentation. Unlike some other eclasses the [distutils-r1 eclass](https://devmanual.gentoo.org/eclass-reference/distutils-r1.eclass/index.html) does not enable support for these tests automatically. This is because there are multiple test runners available for Python. To enable tests for your Python ebuilds, use the `distutils_enable_tests ` function. Similarly, support for documentation building with Sphinx can be added with the `distutils_enable_sphinx [--no-autodoc | ...]` function. Please note that these functions already append to IUSE and RESTRICT, so there is no need to specify this manually.