Information about sending patches for review

Edit this page -- Back to previous index

Download osboot from the Git repository like so:

git clone https://notabug.org/osboot/osbmk.git

You can submit your patches via Notabug pull requests.

osboot development is done using the Git version control system. Refer to the official Git documentation if you don’t know how to use Git.

Building osboot from source

Read the following article: Building osboot from source

How the build system works and how to maintain it

Read the following article: osboot maintainance manual

Do you have a coreboot-compatible system? If it’s not supported in osboot, you are welcome to add support to osboot. You basically need to:

All of this is completely automated. The guide linked above tells you how to add and maintain boards in osboot. osboot is, in essence, an automated build system that describes how to build various ROM images for whatever is in the coreboot repository. Having individual board maintainers in osboot is a high priority for osboot, so as to have greater hardware support with regular testing.

Editing the website and documentation, wiki-style

The website and documentation is written in markdown, hosted in this Git repository:

https://notabug.org/osboot/osbwww

Images are hosted here:

https://notabug.org/osboot/osbwww-img

The website and documentation is inside the www directory in the above osbwww Git repository, in Pandoc flavoured Markdown. The website is generated into static HTML via Pandoc with the following scripts in that directory:

Use any standard text editor (e.g. Vim, Emacs, Nano, Gedit) to edit the files, commit the changes and send patches.

Optionally, you can install a web server (e.g. lighttpd, nginx) locally and set the document root to the www directory in your local Git repository. With this configuration, you can then generate your local version of the website and view it by typing localhost in your browser’s URL bar.

Privacy of contributors (you do not have to reveal your name or identity!)

Contributions that you make are publicly recorded, in a Git repository which everyone can access. This includes the name and email address of the contributor.

In Git, for author name and email address, you do not have to use identifying data. You can use osboot Contributor and your email address could be specified as contributor@osboot.org. You are permitted to do this, if you wish to maintain privacy. We believe in privacy. If you choose to remain anonymous, we will honour this.

Of course, you can use whichever name and/or email address you like.

For enhanced privacy, we recommend that you use a trustworthy VPN provider and route all of your traffic through Tor (on top of the VPN). The Tor website has instructions on it for routing traffic through the Tor network.

Legally speaking, all copyright is automatic under the Berne Convention of international copyright law. It does not matter which name, or indeed whether you even declare a copyright (but we do require that certain copyright licenses are used - read more about that on this same page).

If you use a different name and email address on your commits/patches, then you should be fairly anonymous. Use git log and git show to confirm that before you push changes to a public Git repository.

General guidelines for submitting patches

We require all patches to be submitted under a free license: https://www.gnu.org/licenses/license-list.html.

If submitting binary blobs, an exception is made if it’s a type of blob that osboot accepts (e.g. VGA ROM, CPU microcode updates). osboot will reject most binary blobs, and free software is strongly preferred.

Basically, blobs must be legally redistributable or otherwise easy to derive by writing a script. For instance, mrc.bin extracted from Google Chromebook recovery images.

Always declare a license on your work! Not declaring a license means that the default, restrictive copyright laws apply, which would make your work non-free.

GNU+Linux is generally recommended as the OS of choice, for osboot development.

General code review guidelines

Any member of the public can submit a patch. Members with push access must never push directly to the master branch; issue a Pull Request, and wait for someone else to merge. Never merge your own work!

Your patch will be reviewed for quality assurance, and merged if accepted.

How to download osboot from the Git repository

In your terminal:

git clone https://notabug.org/osboot/osbmk.git

To download the website:

git clone https://notabug.org/osboot/osbwww.git

To download images for the website:

git clone https://notabug.org/osboot/osbwww-img.git

To download the ich9utils utility, which osbmk uses:

git clone https://notabug.org/osboot/ich9utils.git

A new directory named osboot will have been created, containing osboot. Alternatively, you may have downloaded one of the others.

How to submit your patches (via pull requests)

Make an account on https://notabug.org/ and navigate (while logged in) to https://notabug.org/osboot/osbmk. Click Fork and in your account, you will have your own repository of osboot. Clone your repository, make whatever changes you like to it and then push to your repository, in your account on NotABug.

For other repos, see:

Website: https://notabug.org/osboot/osbwww

Images: https://notabug.org/osboot/osbwww-img

If submitting images, they will likely be rejected. We only accept images into the repository when it’s absolutely necessary. Images are to be kept to a minimum, unless they’re actually useful, otherwise the repository will be quickly cluttered.

ich9utils: https://notabug.org/osboot/ich9utils

Now, navigate to https://notabug.org/osboot/osbmk/pulls and click New Pull Request.

For the website, use this link: https://notabug.org/osboot/osbwww/pulls.

For the images, use this link: https://notabug.org/osboot/osbwww-img/pulls

For ich9utils, use this link: https://notabug.org/osboot/ich9utils/pulls

You can submit your patches there. Alternative, you can log onto the osboot IRC channel and notify the channel of which patches you want reviewed, if you have your own Git repository with the patches.

Once you have issued a Pull Request, the osboot maintainers will be notified via email. If you do not receive a fast enough response from the project, then you could also notify the project via the #osboot channel on Freenode.

Edit this pageLicenseTemplateAuthorsDonateBuy preinstalled

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License Version 1.3 or any later version published by the Free Software Foundation with no Invariant Sections, no Front Cover Texts, and no Back Cover Texts. A copy of this license is found in /docs/fdl-1.3.html