Get involved¶
Ways to contribute¶
- Fix or improve the code and documentation — see Submitting changes below.
- Add software to armbian-config — write an install module and its menu entry.
- Add a new board or board family to the build framework.
- Become a board maintainer — keep a board supported, test release candidates and help its users. The Board Support Rules define what each support tier requires.
- Run a mirror — host images and packages for the download network.
Submitting changes¶
- Fork the project.
- Make one or more well commented and clean commits to the repository.
- Perform a pull request in Github’s web interface.
If it is a new feature request, do not start the coding first. Remember to open an issue to discuss the new feature. You can also add code to someone else’s pull request. Also check the collection of git tips which will make your life easier.
If you are struggling, check the WEB or CLI step-by-step guide on contributing.
Source code¶
- Armbian build framework: armbian/build
- Armbian configuration utility: armbian/configng
- Armbian documentation: armbian/documentation
The GitHub page lists the other project repositories.
Roles and what they unlock¶
Contributing needs nothing but a GitHub account. Some project resources are tied to a role:
| Role | What it unlocks |
|---|---|
| Organization member | Member storage — public SFTP space for sharing images and packages |
| Board maintainer | Datacenter access — remote access to real boards in the hardware lab |
| Release manager | Running the release workflows that prepare images for release |
Organization member¶
Every contributor is automatically invited to become a member of the Armbian organization on GitHub. Contribute — for example with a merged pull request — and accept the invitation that follows.
Board maintainer¶
Board maintainers are members of the board-maintainers GitHub team. See Become a board maintainer for how to apply, the requirements, and what is expected of you.
Release manager¶
This role has additional permission that allows preparation of images for release.
Release managers: https://github.com/orgs/armbian/teams/release-manager