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.
Todo
We need a 404 document to help people handle broken links (report, find, etc.).
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/404.rst, line 8.)
Todo
add cape compatibility details
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/01-introduction.rst, line 75.)
Todo
This section needs more work and references to greater detail. Other boot modes are possible. Software to support USB and serial boot modes is not provided by beagleboard.org._Please contact TI for support of this feature.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/03-design-and-specifications.rst, line 239.)
Todo
Variable & MAC Memory
VSYS_IO_3V3
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/04-expansion.rst, line 1663.)
Todo
Clean/Update table
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/04-expansion.rst, line 1688.)
Todo
Align with other boards and migrate away from pin usage entries for BeagleBone Black expansion
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/04-expansion.rst, line 1758.)
Todo
Add BeagleBone AI-64 cape mechanical characteristics**
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/04-expansion.rst, line 2128.)
Todo
IMX219 CSI sensor connection with BeagleBone® AI-64 for Edge AI
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst, line 78.)
Todo
BeagleBone® AI-64 wallpaper upon boot
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst, line 182.)
Todo
Microsoft Visual Studio Code for connecting to BeagleBone® AI-64 for Edge AI via SSH
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst, line 243.)
Todo
Need info on BBAI boot mode settings
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch05.rst, line 259.)
Todo
Need info on BBAI power management
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch05.rst, line 264.)
Todo
Add WiFi/Bluetooth/Ethernet
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch05.rst, line 269.)
Todo
This text needs to go somewhere.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch05.rst, line 276.)
Todo
This table needs entries
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1490.)
Todo
Table entries needed
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1582.)
Todo
Need info on BealgeBone AI serial debug
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1596.)
Todo
Need info on BealgeBone AI USB Type-C connection
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1601.)
Todo
Need info on BealgeBone AI USB Type-A connection
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1606.)
Todo
Need info on BealgeBone AI USB Gigabit Ethernet connection
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1611.)
Todo
Need info on BealgeBone AI u.FL antenna connection
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1616.)
Todo
Need info on BealgeBone AI uSD card slot
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1621.)
Todo
Need info on BealgeBone AI uHDMI connection
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch07.rst, line 1626.)
Todo
Reference https://docs.beagleboard.org/latest/intro/support/index.html and https://beagleboard.org/resources
Related TI documentation: http://www.ti.com/tool/BEAGLE-3P-BBONE-AI
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/ai/ch11.rst, line 6.)
Todo
Make all figure references actual references
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/black/ch07.rst, line 1163.)
Todo
move accessory links to a single common document for all boards.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/black/ch07.rst, line 1184.)
Todo
We should include all support information in docs.beagleboard.org now and leave eLinux to others, freeing it as much as possible
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/black/ch07.rst, line 1194.)
Todo
We are going to work on a unified accessories page for all the boards and it should replace this.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglebone/blue/accessories.rst, line 6.)
Todo
Image with what’s inside the box and a better description.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/freedom/02-quick-start.rst, line 14.)
Todo
Describe how to get a serial connection.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/freedom/02-quick-start.rst, line 55.)
Todo
Describe how to get an IEEE802.15.4g connection from BeaglePlay.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/freedom/02-quick-start.rst, line 62.)
Todo
Describe how to get to a local console and websockets console.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/freedom/02-quick-start.rst, line 73.)
Todo
Need to describe functionality of 0.2.2
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/freedom/demos-and-tutorials/using-micropython.rst, line 201.)
Todo
provide images demonstrating Jupyter Notebook visualization
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/index.rst, line 64.)
Todo
think a bit more about this section with some feedback from Cathy.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleconnect/index.rst, line 83.)
Todo
Add specific power-up/down sequence notes here as well a highlight any limitations and known issues.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/03-design.rst, line 123.)
Todo
Put the step into play-kernel-development.rst to revert back to the Beagle kernel.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/understanding-boot.rst, line 91.)
Todo
Need an image of the logo
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 44.)
Todo
To make it stick, …
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 142.)
Todo
Document kernel version that integrates this overlay and where to get update instructions.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 248.)
Todo
How do turn off the driver?
How do turn on spidev?
How do I enable GPIO?
How do a provide a manifest?
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 293.)
Todo
Needs udev
Needs live description
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 301.)
Todo
Describe how to know it is working
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 56.)
Todo
A big part of what is missing here is to put your BeaglePlay on the Internet such that we can download things in later steps. That has been initially brushed over.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 67.)
Todo
west build -d build/sensortest zephyr/samples/boards/beagle_bcf/sensortest -- -DOVERLAY_CONFIG=overlay-subghz.conf
west build -d build/wpanusb modules/lib/wpanusb_bc -- -DOVERLAY_CONFIG=overlay-subghz.conf
west build -d build/bcfserial modules/lib/wpanusb_bc -- -DOVERLAY_CONFIG=overlay-bcfserial.conf -DDTC_OVERLAY_FILE=bcfserial.overlay
west build -d build/greybus modules/lib/greybus/samples/subsys/greybus/net -- -DOVERLAY_CONFIG=overlay-802154-subg.conf
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 351.)
Todo
Describe how to handle the serial connection
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 391.)
Todo
remove “<To-Do>” items in the table below.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/01-introduction.rst, line 55.)
Todo
add instructions for flashing in windows.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/02-quick-start.rst, line 211.)
Todo
add instructions for flashing in Mac.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/02-quick-start.rst, line 215.)
Todo
We need a CSI capture and DSI display demos
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/05-demos.rst, line 7.)
Todo
We need a cape compatibility layer demo
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/05-demos.rst, line 11.)
Todo
update details
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/06-support.rst, line 14.)
Todo
update details
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/ahead/06-support.rst, line 23.)
Todo
add image & information about box content.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/02-quick-start.rst, line 11.)
Todo
We need a CSI capture demos
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/05-demos.rst, line 6.)
Todo
We need a cape compatibility layer demo
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/05-demos.rst, line 10.)
Todo
update details
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/06-support.rst, line 14.)
Todo
update details
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/06-support.rst, line 23.)
Todo
This is the hard way! Special cables and FlashPros are not required when using the firmware we initially ship on the board. This tutorial should be rescripted as how to _unbrick_ your board. Also, we have other work-arounds using software and GPIOs rather than FlashPros. Let’s not put this in user’s face as the experience when it is far more painful than using the change-gateware.sh script and “hold BOOT button when applying power” solutions we’ve created!
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst, line 6.)
Todo
Make sure people know about the alternative and we provide links to details on that before we send them down this process.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/beaglev/fire/demos-and-tutorials/mchp-fpga-tools-installation-guide.rst, line 13.)
Todo
figure out if BONE-SPI0_0 and BONE-SPI0_1 can be loaded at the same time
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 581.)
Todo
We need a udev rule to make sure the ADC shows up at /dev/bone/adc! There’s nothing for sure that IIO devices will show up in the same place.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 750.)
Todo
I think we can also create symlinks for each channel based on which device is there, such that we can do /dev/bone/adc/Px_y
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 752.)
Todo
I believe a multiplexing IIO driver is the future solution
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 754.)
Todo
remove deep references to git trees
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 849.)
Todo
Additional quadrature encoders can be implemented in PRU firmware.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 947.)
Todo
This doesn’t include any abstraction yet.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 1018.)
Todo
Describe I2S and ALSA
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 1218.)
Todo
Document dynamic DT overlays
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 1471.)
Todo
Document dynamic pinmux control
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 1478.)
Todo
Describe how the Device Trees expose symbols for reuse across boards
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 1490.)
Todo
The steps used to verify all of these configurations is to be documented here. It will serve to document what has been tested, how to reproduce the configurations, and how to verify each major triannual release. All faults will be documented in the issue tracker.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/cape-interface-spec.rst, line 1526.)
Todo
Get OSHWA certification for all of our capes and update the documentation to reflect that
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/boards/capes/index.rst, line 9.)
Todo
Add cape examples of various sizes
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/books/beaglebone-cookbook/09capes/capes.rst, line 18.)
Todo
Update display cape example
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/books/beaglebone-cookbook/09capes/capes.rst, line 23.)
Todo
Make a mapping table for the Black
https://github.com/FalconChristmas/fpp/blob/master/src/pru/OctoscrollerV2.hp
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/books/pru-cookbook/05blocks/blocks.rst, line 1816.)
Todo
Make sure we have everything critical from https://beagleboard.github.io/bone101/Support/bone101/
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/intro/beagle101/index.rst, line 41.)
Todo
Create a simple drawing of BeaglePlay connecting to an external add-on with an interesting device on it.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/intro/beagle101/qwiic-stemma-grove-addons.rst, line 12.)
Todo
Why “device” drivers?
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/intro/contribution/linux-upstream.rst, line 148.)
Todo
Why do we need drivers?
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/intro/contribution/linux-upstream.rst, line 152.)
Todo
What do drivers look like?
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/intro/contribution/linux-upstream.rst, line 156.)
Todo
The terminology Implicit and Explicit is not accurate here.
(The original entry is located in /builds/cshegedus/docs.beagleboard.io/intro/contribution/rst-cheat-sheet.rst, line 299.)
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.