Date: Tue, 23 Jul 2019 21:29:59 +0200
From: Natanael Copa <ncopa@alpinelinux.org>
To: Olliver Schinagl <oliver+list@schinagl.nl>
Cc: alpine-devel@lists.alpinelinux.org
Subject: Re: Alpine Linux aports codestyle
Message-ID: <20190723212959.316ab849@ncopa-desktop.copa.dup.pw>
In-Reply-To: <1c2e99a3-4995-296d-b6e1-6fbad8261ab8@schinagl.nl>
References: <1c2e99a3-4995-296d-b6e1-6fbad8261ab8@schinagl.nl>
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit

On Tue, 23 Jul 2019 08:28:11 +0200
Olliver Schinagl <oliver+list@schinagl.nl> wrote:

> Hey list,
> 
> over the past year or so, I've started to contribute to Alpine Linux's 
> aports, and have met various codestyles. To get to the bottom of what is 
> 'the' Alpine Linux codestyle, I came up empty handed, there is no 
> CODESTYLE.md, no search query that finds anything nor on the wiki.
> 
> Now of course, the document could be hiding out of plain site, and if 
> that is the case, other then saying 'make it findable', I appologize for 
> even bringing anything up here.

> As I was about to do a version bump to community/mtd-utils, I noticed
> a lot of activity on the package, a great thing!. Sadly I came to the 
> realization, that in the 'default' aports workflow, the 
> maintainers/contributers do not get CC-ed on changes. As I'm mostly
> only familiar with Linux, U-Boot and busybox development, I missed
> the 'get_maintainers' step, where people involved in abuild's would
> be kept in the loop.

This can and be improved.

> Never the less, what triggered for me to address the mailing list 
> however was commit 57d39405ad74 ("community/mtd-utils: adhere to
> aports code style"). As the subject already states, 'adhere to aports
> code style' is mentioned, but as mentioned earlier, I cannot seem to
> find this aforementioned code style. It should be obvious then of
> course, that when asking people to adhere to a coding style, this
> style needed to be documented (and more importantantly rationalized).
> It shouldn't needed to be mentioned, by having a guide (that can be
> checked with linters/checkers) makes life easier, for both developers
> and reviewers (passes automated code checks, no need to argue about
> style anymore).
> 
> So in short, where is the style guide that everybody keeps talking
> about :)

Its still unwritten, sorry. I guess its based on what is common for the
majority of the APKBUILDs. It is ofcourse not realistic that everyone
read all of the thousands of APKBUILDs to get how things are normally
done, so yeah, this should be fixed.

I created an issue: https://gitlab.alpinelinux.org/alpine/aports/issues/10689

> 
> Thank you,
> 
> Olliver