Gentoo Archives: gentoo-dev

From: "Michał Górny" <mgorny@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] New QA Policy Guide
Date: Sun, 19 Jan 2020 20:09:03
Message-Id: cdad8d446c744e68e05a5d6cc5eff7cc316f37d3.camel@gentoo.org
In Reply to: Re: [gentoo-dev] New QA Policy Guide by "Robin H. Johnson"
1 On Sun, 2020-01-19 at 19:34 +0000, Robin H. Johnson wrote:
2 > On Sun, Jan 19, 2020 at 12:31:52PM +0100, Michał Górny wrote:
3 > > Hello,
4 > >
5 > > In the light of the recent misunderstandings, I have started working
6 > > on an official Policy Guide [1]. The Guide is meant to provide
7 > > a focused list of officially approved QA policies, along with their
8 > > rationale and any other useful information.
9 > >
10 > > This should supplement devmanual [2] with clear information on what is
11 > > enforceable policy, and what is merely a suggestion (or possibly
12 > > outdated information, which is a common problem for devmanual).
13 > Thank you for this this!
14 >
15 > I have some requests for improvement & content.
16 >
17 > 1. Stable identifiers for policy:
18 > Assign ID numbers or stable identifying slugs to each policy and use
19 > them for referencing from all tooling in future. Also makes searching
20 > MUCH easier.
21 >
22 > The ID variant might be 'GPNNNNN' (string prefix, followed by numeric
23 > value)
24 >
25 > The slug variant (modelled after Rubocop) might be
26 > "Ebuild:CodingStyle"
27 >
28 > My personal preference would be the ID variant, after seeing Rubocop
29 > have to rename identifying slugs slowly & painfully over many years;
30 > however the slug variant is MUCH better for usability
31 >
32 > 2. Usability/viewing:
33 > 2.1. DT-squashed:
34 > Please fix the CSS rendering of the <dt>. My chrome window is 1198 x
35 > 1870 (screen is portrait version 1920x1200).
36 > Screenshot:
37 > https://dev.gentoo.org/~robbat2/.private/20200119-policy-guide-render-window.png
38 >
39 > 2.2. Whitespace:
40 > The left column has a LOT of wasted whitespace.
41 >
42 > 2.3 Navigation:
43 > Please add next/previous links on the top AND bottom of each page.
44 >
45
46 Ok, I am sorry. I've sent this mail with the conviction that new
47 version was deployed but I've been informed that it didn't. I've
48 manually updated the site now, and it should show the new theme after
49 refresh.
50
51 --
52 Best regards,
53 Michał Górny

Attachments

File name MIME type
signature.asc application/pgp-signature