57787e72f5
* chore(readme): fix readme docs * chore(readme): fix discord link * chore: readme * chore(readme): fix jira link
29 lines
1.7 KiB
Markdown
29 lines
1.7 KiB
Markdown
# How to contribute
|
|
|
|
## Getting started
|
|
|
|
- Fork the repository on GitHub
|
|
- Read the README.md for build instructions
|
|
|
|
## Issue
|
|
|
|
Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so try to recreate it with a clean build framework clone. Then search for [existing and closed issues](https://github.com/armbian/build/issues). If you don't find it there, [open a new issue](https://github.com/armbian/build/issues/new).
|
|
|
|
## Adding a new feature
|
|
|
|
You are welcome to suggest or contribute directly to the code with a pull request. In case your proposed changes are large, remember to discuss them prior to development.
|
|
|
|
## Join development
|
|
|
|
Join regulars on their active missions, start maintaining any part of the code: patches, drivers or scripted applications like [armbian-config](https://github.com/armbian/config), address [community wishes](https://github.com/armbian/build/issues),
|
|
|
|
## Additional information
|
|
|
|
- [Build parameters and advanced build options](https://docs.armbian.com/Developer-Guide_Build-Options/),
|
|
- [Make use of user defined configurations](https://docs.armbian.com/Developer-Guide_User-Configurations/),
|
|
- [Docker](https://docs.armbian.com/Developer-Guide_Building-with-Docker/) and [Vagrant](https://docs.armbian.com/Developer-Guide_Using-Vagrant/) building guides,
|
|
- Engage in [Armbian build framework forums](https://forum.armbian.com/forum/4-development/),
|
|
- Check [Jira](https://armbian.atlassian.net/browse/AR) project management application status,
|
|
- Make use of central project [search engine](https://www.armbian.com/search),
|
|
- Browse [IRC channel logs](http://irc.armbian.com) or interact at #armbian on [Libera](https://libera.chat/).
|