diff options
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 48 |
1 files changed, 14 insertions, 34 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ff746ab76..f3a399011 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,7 +6,7 @@ :Status: Draft :Copyright: - © 2016 Adélie Linux Team. NCSA open source licence. + © 2017 Adélie Linux Team. NCSA open source licence. @@ -14,9 +14,9 @@ Introduction ============ -This repository contains the Adélie Linux package set. It is used as an -overlay in the Portage system for package building to create the repository -used by Adélie's APK package manager. +This repository contains the Adélie Linux package set. It is used by the +Adélie Linux build system for package building to create the repository used +by Adélie's APK package manager. Licenses @@ -39,26 +39,20 @@ sec-bugs@adelielinux.org. -Ebuild Format -============= +Package Format +============== -This section describes the Ebuild format required for packages in this -repository. - - -EAPI -```` - -Any Ebuild present in this repository **must** use EAPI 5. As EAPI 6 is not -yet supported by any publicly released version of the Portage toolkit, it is -not yet acceptable for use in this repository. +This section describes the APKBUILD format and patch format required for +packages in this repository. Source URIs ``````````` -It is recommended that any Ebuild present in this repository use an official -Adélie Linux mirror for any files downloaded (``mirror://adelie/``). +It is recommended that any package present in this repository use an official +Adélie Linux mirror for any files downloaded (``mirror://adelie/``), unless +the file resides on the package's official package mirror. + Exceptions will be granted on a case-by-case basis for issues such as file size or rapid version change. @@ -66,23 +60,9 @@ size or rapid version change. Comments ```````` -It is highly encouraged that you use comments in your Ebuild. This grants +It is highly encouraged that you use comments in your package. This grants other developers and the Adélie Linux team the same level of understanding -that you have over the package. Any issues found that cause behaviour -deviant from the eclass defaults should have an explanation and/or link to -a problem report (either upstream or on http://bts.adelielinux.org/). - - -Custom Eclasses -``````````````` - -If you require a custom Eclass not already present in the base Portage tree -or this repository, please file a problem report on http://bts.adelielinux.org/ -with an explanation of what your Eclass will provide. A test suite in the -form of various Ebuilds demonstrating proper behaviour and failure modes will -be greatly appreciated and raise the likelihood of a speedy addition to the -tree. Please do **not** file a pull request containing a new Eclass without -filing a problem report first. +that you have over the package. |