Contribution Guide for Adélie Linux Package Set
|Copyright:||© 2017-2018 Adélie Linux Team. NCSA open source licence.|
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.
As the Adélie Linux project is an open-source Linux distribution, packages contained in this repository must also be provided under a license recognised by the OSI. A separate repository may be provided in the future for certain non-free components, such as device driver firmware.
Any changes to this repository - additions, removal, or version bumps - must be reviewed before being pushed to the master branch. There are no exceptions to this rule. For security-sensitive updates, contact the Security Team at email@example.com.
This section describes the APKBUILD format and patch format required for packages in this repository.
It is recommended that any package present in this repository use an official
Adélie Linux mirror for any files downloaded (
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.
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.
This section describes the usual flows of contribution to this repository. For a detailed description of how to contribute to Adélie Linux, review the Handbook.
GitLab Pull Requests
- If you do not already have a GitLab account, you must create one.
- Create a fork of the packages repository. For more information, consult the GitLab online documentation.
- Clone your forked repository to your computer.
- Make your changes.
- Test your changes to ensure they are correct.
- Add (or remove) changed files using
- Commit your changes to the tree using the commands
git commit -Sand
- Visit your forked repository in a Web browser.
- Choose the Create Pull Request button.
- Review your changes to ensure they are correct, and then submit the form.
Clone the packages repository to your computer.
Make your changes.
Test your changes to ensure they are correct.
Add (or remove) changed files using
Commit your changes to the tree using the command
git commit -S.
Use the command
git format-patch HEAD^to create a patch file for your commit.
If you have made multiple commits to the tree, you will need to add an additional ^ for each commit you have made. For example, if you have made three commits, you will use the command
git format-patch HEAD^^^.
Email the resulting patch to the mailing list, using
git send-emailor your mail client. The mailing list is firstname.lastname@example.org.