User:DarthGandalf/PMStyle

Proxy-maint follows QA and devmanual policies, and in addition to that, dictates some general styling guidelines. That is not uncommon within big projects who maintain a lot of packages. Rationale being common consistent styling, and especially in proxy-maint project it makes ebuilds and files more readable which enables faster review times. Proxy-maint also follows default skel syntax for ebuild and files.

Usually cosmetic issues are not a reason to reject your contribution, but if other QA issues are pointed out and asked to fix, you might be additionally asked to fix any cosmetic issues to honor our guidelines. Please work with us.

Avoid using single-char *DEPEND variable
Instead use any definitive word instead of 1 char. Such as,  ,   and such.

Any 1-character *DEPEND should be reserved for internal portage usage. When such variable is introduced, we don't have to start updating multiple ebuilds, because we've done the preventive work already. https://wiki.gentoo.org/wiki/Future_EAPI/New_dependency_types

Clean, compact, readable
clean metadata.xml, avoid: Foo Bar foo@b.ar

Use: Foo Bar foo@b.ar

Where line length doesn't exceed 100 chars.

Add more text here.

Descriptive text
We don't put " " at the end of descriptive texts. field in an file, or   in  fall under this identification.

One empty line below EAPI line
Simply because we follow the default skel format, and default is written that way. For consistency's sake amongst the ::gentoo repo.

Plaintexting ${PN}
We like to plaintext ${PN} variable in SRC_URI and REPO_URI, because it's not a changeable variable and makes copy-pasting from your ebuild easier, or using external tools such as grep.

Sort unconditional deps before conditional ones
Add text here.

Handling multi live/release ebuilds
It's not uncommon to see a structure similar to below in ebuilds:

if ${PV} == 9999 ; then inherit git-r3 EGIT_REPO_URI="https://github.com/author/package.git" else SRC_URI="https://github.com/author/package/archive/v${PV}.tar.gz -> ${P}.tar.gz" KEYWORDS="~amd64 ~arm ~arm64 ~x86" fi

Few notes: Use "if ${PV} == 9999 ; then" instead of "case". It's cleaner, simpler, shorter and proven to work with different package manager implementations. Do not specify  inside "9999" block, as it breaks the   tool.