Contributing to libmaple¶
First of all, thanks! Community contributions are what makes open source great.
If your patch is minor (you’ve found a typo, you’ve added a new function, etc.), feel free to just make a forum post describing your changes.
If your changes are larger (you wrote a new library, you added support for a new peripheral, etc.), we’d prefer you submit a pull request on Github or send us a nicely-formatted patch via email.
Preparing Your Patch¶
Before submitting a patch, please make sure it complies with the coding standard. Consistent style throughout the source tree is an important implementation objective for us, and a patch that doesn’t comply with the coding standard we’ve set forth is likely to be sent back until it follows the standard.
We would prefer if you release each new file you submit under the MIT license. See e.g. bkp.h for an example, and the coding standard for more details. Code released under the Lesser GPL may be accepted for Wirish, but will almost certainly be rejected for libmaple proper. We will not accept patches released under the GPL.
We’re not against the GPL! It just doesn’t suit our purposes for libmaple. If you’re interested in a GPLed library for ST microcontrollers, check out libopenstm32. Also note that libraries released under the GPL are fine, we just don’t want any core libmaple or Wirish code to be GPLed.
Submitting Via Github Pull Request (Preferred)¶
The most convenient way for you to contribute patches is to submit a pull request on Github. Github provides excellent code review interfaces, which will make it easy for us at LeafLabs to communicate with you (and each other) about your patch. It also makes it easy for us to merge your patch into the libmaple source tree when the time comes.
The steps to submit a pull request are as follows:
- If you don’t already have one, get a GitHub account (free).
- Fork libmaple, then clone your fork to the computer you code on. GitHub provides detailed instructions on forking and cloning a repository.
- Push your commits to your GitHub libmaple fork (see instructions linked in Step 2 for a step-by-step walkthrough on how to do this).
- Submit a pull request to the LeafLabs version of libmaple.
Submitting Via Email¶
If you’re unfamiliar with Git or would prefer not to use GitHub, you can always send us a patch via email at info@leaflabs.com. We’d love it if you used the Linux kernel patch format, but please at least include the following information in your email:
- How you generated your patch (arguments to diff, etc.)
- What git branch/commit or libmaple version your patch applies to
- A one-line summary of your changes, along with any other details you think we should know.
- A sign-off line certifying your developer certificate of origin.
That said, we’d really prefer a pull request. If you’d like to learn more about Git, we recommend the following resources:
- The Git Community Book: A collaboratively edited book on Git.
- Pro Git: despite its title, this is a fairly beginner-friendly source of information.
- Understanding Git Conceptually: a good, introductory tutorial on Git’s fundamental concepts.
- Git for Computer Scientists: if you’re comfortable with directed acyclic graphs, this resource explains Git’s functionality in graph-theoretic terms.
