This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . */ header('Content-type: text/html; charset=utf-8'); ob_start(); include_once "../common/variables.php"; include_once "../common/functions.php"; ?> <?php echo gettext("Information for libreboot developers and contributors"); ?>

Useful information, related to libreboot development, including links to the Git repositories where development is done.

How can I help the libreboot project? #howtohelp

Libreboot is becoming part of the GNU project, and we need help with the transition. Click here for more information

There are many ways that you can assist the libreboot project. We have a list of tasks that need to be completed, which you can work on (you can also add to that list). Generally speaking, adding support for more hardware is a priority for the libreboot project. Information about maintaining libreboot can be found here and building libreboot here.

We especially need more skilled coreboot hackers to do work that will benefit the libreboot project. This includes porting new boards to coreboot, which are likely to be valid candidates for libreboot.

Learn libreboot from the inside out; download the git repository, and study libreboot. We need more full-time developers who can help to maintain the project.

Not a developer? You can still help!

General guidelines for submitting patches #guidelines

Some people put their name on their work, for recognition, and it's OK if you want to do that; however, the libreboot project does not require this. Some projects (such as coreboot) require a legal name, and this can be problematic for certain groups of people.

Using your legal name is not required when submitting patches to libreboot. For reasons why we have this policy, read this article. You can use any name of your chosing, or your company name (if you have one), if you want or need to do that. You can also submit patches without a name, if you want or need to do that (instructions are provided on this page). Also, read this article. Unfortunately, git appears to be stuck with these problems, when an author changes their name, and we don't have a concrete answer to it. As far as we know, publishing your legal name isn't even required for copyright purposes; in fact, "pen" names are commonly used by literary authors (computer programs are literary works).

When submitting any kind of documentation, try not to use the terms him/her, she/he, his/her, or anything that is gender biased. Use their, they, them, those people, that person, and so on. You are making a huge difference.

copyleft preferred)."); ?> https://www.gnu.org/licenses/license-list.html. NOTE: not putting a copyright notice on a work does not mean it lacks copyright. Copyright is automatic in most countries. Not putting a license on a work also does not make that work free; you have to declare a free license, otherwise the default, restrictive copyright laws apply for those who wish to do anything with your work. Always put a license on your work!

Small technical note: libreboot is working to convert all documentation to texinfo, where it is currently written in HTML, directly. Therefore, please submit any new documentation under this format, during the transition period. Learn more.

Back to top of page

#download

Libreboot development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).

This also contains the documentation:"); ?>

Use this command, to download the repository:
git clone
...you can also browse this repository on the web

A new directory named libreboot will have been created, containing libreboot.

Documentation is in the other repository:"); ?>

Use this command, to download the repository:
git clone
...you can also browse this repository on the web

A new directory named libreboot-website will have been created, containing the libreboot website files.

Use these if one of the main repositories are down.

git clone "; ?>

git clone "; ?>

Back to top of page

How to submit your patches #sendpatch

You can email this information to , which is the mailing list used for libreboot development discussion.

Check #githosting, for a list of Git hosting providers that we recommend.

You can email your patches to , which is the mailing list used for libreboot development discussion.

Back to top of page

List of recommended Git hosting providers #githosting

There are several that we could recommend:

The libreboot project itself uses all of the above options.

Most Git hosting providers distribute non-free JavaScript on their website, but as far as we are aware all of these providers are freedom-friendly and reliable to use (and their JavaScript is free). This list will be expanded upon at a later date. The hosting providers above are all powered by Free Software, which means that you can also host your own version of the software that they use on their website.

We generally recommend self-hosting (first option in the list above). Git is a decentralized (distributed) version control system. However, not everyone can afford to do this, so using one of the other providers on the list above is also acceptable.

**PLEASE** DO NOT USE GitHub. Learn more here.

**PLEASE** DO NOT USE GitLab. Learn more here.

Back to top of page

#contrib

Libreboot development is facilitated by git, a distributed version control system that is in wide use today. Git provides many practical benefits, making collective development of software very easy.

git documentation describes how to use git. The following notes include simple tips for how to use git, but it is a good idea to get fully acquainted with git."); ?>


git config --global user.name "Your Name"
git config --global user.email your@emailaddress.com
NOTE: you do not have to use your legal name; we don't care what name you use. You can use any name of your choosing. If you wish to be anonymous (no name), you can also use Libreboot Contributor as your name, and noname@libreboot.org as the email address. We will happily accept anonymous contributions in the libreboot project.


git config --global core.editor vim # NOTE: on most systems, git defaults to using vi anyway. If you switch to vim, make sure it's installed
git config --global color.status auto
git config --global color.branch auto
git config --global color.interactive auto
git config --global color.diff auto

NOTE: the above steps for colour make git use red/green font colours for showing diffs. If you are red/green colour-blind, please ignore the above steps. The default configuration in git is no-colour (all one colour, usually the default that your terminal uses). If you are colour-blind, git can display in other colours; refer to the git documentation.

libreboot directory."); ?>

When working with git, you will need your current working directory to be inside the libreboot directory that was just created.
cd libreboot/


git status

git add path/to/file. You should also add any other files that are listed as modified in the git status. If there are deleted files in the git status, you can use git rm path/to/file. As long as you have added all the untracked files, it is generally easier to use:"); ?>
git commit -a
git commit)"); ?>


git commit --amend

git commit -a --amend

If you wish to use a different author name for the commit command, add --author="Author's Name <author's email address>" at the end. This could be any name your choosing, or it could be because you are submitting a patch on someone else's behalf. If you wish to be anonymous (no name), you can also use Libreboot Contributor as your name, and noname@libreboot.org as the email address. We will happily accept anonymous contributions in the libreboot project.

Check once more that everything you want is added. Use the git status command to check for untracked changes/files, and adapt accordingly. Once you've committed everything, your changes will appear in a diff format, using this command:
git show
Use PgUp/PgDown to navigate the diff output. This uses the less utility, so all the features from that (e.g. keyword search) are also available.


git log


git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"

git lol
git log, but it's much better and shows branches, etc."); ?>

Back to top of page