Contribution¶
Note
This section is under developmement right now.
Important
First off, thanks for taking the time to think about contributing!
Note
For donations, see BeagleBoard.org - Donate.
The BeagleBoard.org Foundation maintains source for many open source projects.
Example projects suitable for first contributions:
These guidelines are mostly suggestions, not hard-set rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Code of Conduct¶
This project and everyone participating are governed by the same code of conduct.
Note
Check out https://forum.beagleboard.org/faq as a starting place for our code of conduct.
By participating, you are expected to uphold this code. Please report unacceptable behavior to contact one of our administrators or moderators on https://forum.beagleboard.org/about.
Frequently Asked Questions¶
Please refer to the technical and contribution frequently asked questions pages before posting any of your own questions. Please feel encouraged to ask follow-up questions if any of the answers are not clear enough.
What should I know before I get started?¶
The more you know about Linux and contributing to upstream projects, the better, but this knowledge isn’t strictly required. Simply reading about contributing to Linux and upstream projects can help build your vocabulary in a meaningful way to help out. Learn about the skills required for Linux contributions in the Upstream Kernel Contributions section.
The most useful thing to know is how to ask smart questions. Read about this in the Getting support section. If you ask smart questions on the issue trackers and forum, you’ll be doing a lot to help us improve the designs and documentation.
How can I contribute?¶
The most obvious way to contribute is using the git.beagleboard.org Gitlab server to report bugs, suggest enhancements and providing merge requests, also called pull requests, the provide fixes to software, hardware designs and documentation.
Reading the help guide is a great way to get started using our Gitlab server.
This documentation has a number of todo items where help is needed that can be searched in the source. This list will
show up directly in the staging documentation at https://docs.beagleboard.io/latest/intro/contribution/index.html#how-can-i-contribute.
Reporting bugs¶
Start by reading the Gitlab Issues help page.
Please request an account and report any issues on the appropriate project issue tracker at https://git.beagleboard.org.
Report issues on the software images at https://git.beagleboard.org/explore/topics/distros.
Report issues on the hardware at https://git.beagleboard.org/explore/projects/topics/boards.
Suggesting enhancements¶
An issue doesn’t have to be something wrong, it can just be about making something better. If in doubt how to make a productive suggestion, hop on the forum and live chat groups to see what other people say. Check the current ideas that are already out there and give us your idea. Try to be constructive in your suggestion. We are a primarily a volunteer community looking to make your experience better, as those that follow you, and your suggestion could be key in that endeavor.
Where available, use the “enhancement” label on your issue to make sure we know you are looking for a future improvement, not reporting something critically wrong.
Submitting merge requests¶
If you want to contribute to a project, the most practical way is with a merge request. Start by creating a fork, which is your own copy of the project you can feel free to edit how you see fit. When ready, create a merge request and we’ll review your work and give comments back to you. If suitable, we’ll update the code to include your contribution!
A bit more detailed suggestions can be found in the articles linked below.