| 1 |
On Sun, Jan 19, 2020 at 12:31:52PM +0100, Michał Górny wrote: |
| 2 |
> Hello, |
| 3 |
> |
| 4 |
> In the light of the recent misunderstandings, I have started working |
| 5 |
> on an official Policy Guide [1]. The Guide is meant to provide |
| 6 |
> a focused list of officially approved QA policies, along with their |
| 7 |
> rationale and any other useful information. |
| 8 |
> |
| 9 |
> This should supplement devmanual [2] with clear information on what is |
| 10 |
> enforceable policy, and what is merely a suggestion (or possibly |
| 11 |
> outdated information, which is a common problem for devmanual). |
| 12 |
Thank you for this this! |
| 13 |
|
| 14 |
I have some requests for improvement & content. |
| 15 |
|
| 16 |
1. Stable identifiers for policy: |
| 17 |
Assign ID numbers or stable identifying slugs to each policy and use |
| 18 |
them for referencing from all tooling in future. Also makes searching |
| 19 |
MUCH easier. |
| 20 |
|
| 21 |
The ID variant might be 'GPNNNNN' (string prefix, followed by numeric |
| 22 |
value) |
| 23 |
|
| 24 |
The slug variant (modelled after Rubocop) might be |
| 25 |
"Ebuild:CodingStyle" |
| 26 |
|
| 27 |
My personal preference would be the ID variant, after seeing Rubocop |
| 28 |
have to rename identifying slugs slowly & painfully over many years; |
| 29 |
however the slug variant is MUCH better for usability |
| 30 |
|
| 31 |
2. Usability/viewing: |
| 32 |
2.1. DT-squashed: |
| 33 |
Please fix the CSS rendering of the <dt>. My chrome window is 1198 x |
| 34 |
1870 (screen is portrait version 1920x1200). |
| 35 |
Screenshot: |
| 36 |
https://dev.gentoo.org/~robbat2/.private/20200119-policy-guide-render-window.png |
| 37 |
|
| 38 |
2.2. Whitespace: |
| 39 |
The left column has a LOT of wasted whitespace. |
| 40 |
|
| 41 |
2.3 Navigation: |
| 42 |
Please add next/previous links on the top AND bottom of each page. |
| 43 |
|
| 44 |
2.4. Search results: |
| 45 |
Many two-letter search terms return nothing, "QA", "QT" |
| 46 |
|
| 47 |
3. Content requests: |
| 48 |
3.1. |
| 49 |
Cover policy around ELF binary dependency verification (this related to |
| 50 |
the ebuild maintainer quiz question "How can you verify an ebuild has |
| 51 |
correct run time dependencies (RDEPEND) for all installed binaries?" |
| 52 |
|
| 53 |
3.2. |
| 54 |
Cover policy around making sure that ALL licenses around installed |
| 55 |
data being listed in the LICENSE variable, which is becoming |
| 56 |
increasingly important for Rust & Go where the output binaries are |
| 57 |
usually static, and many licenses might be included via dependencies |
| 58 |
on the codebase. |
| 59 |
|
| 60 |
-- |
| 61 |
Robin Hugh Johnson |
| 62 |
Gentoo Linux: Dev, Infra Lead, Foundation Treasurer |
| 63 |
E-Mail : robbat2@g.o |
| 64 |
GnuPG FP : 11ACBA4F 4778E3F6 E4EDF38E B27B944E 34884E85 |
| 65 |
GnuPG FP : 7D0B3CEB E9B85B1F 825BCECF EE05E6F6 A48F6136 |
Archives
