From 99937b32e5881d47109ab585a3dfe09de3bc9f08 Mon Sep 17 00:00:00 2001 From: Francis Rowe Date: Mon, 23 Feb 2015 02:22:13 -0500 Subject: Instructions for contributing patches --- diff --git a/site/download/index.php b/site/download/index.php index f4c5753..f1ed4df 100644 --- a/site/download/index.php +++ b/site/download/index.php @@ -182,8 +182,8 @@

Git repositories (development)

- These git repositories are intended for the development of . - The ROM images built from git are untested, and therefore not + The git repositories are intended for developing . + ROM images built from the git repository are untested, and therefore not recommended for general use (you should assume that they will brick your computer).

@@ -198,26 +198,93 @@ can be found at ../gitdocs/index.html.

-

Main repositories

+

How to download

- This is the main repository, hosted by the project. + Firmware (coreboot distribution):
+ $ git clone

- Firmware: $ git clone
- Website: $ git clone + website:
+ $ git clone

- Please do not use GitHub! + Backup repositories can be found at #gitbackup.

+ -

Backup repositories

+

Submitting patches to

- Backup repositories, in case the main repository is down. - Although these are regularly updated by the project, you - should ideally use the main repository. + The git documentation describes how to use git.

- Please do not use GitHub! + Make sure that you configured git so that your name and email + address appear in the commits that you create:
+ $ git config --global user.name "Your Name"
+ $ git config --global user.email your@emailaddress.com +

+

+ The following is also useful:
+ $ git config --global core.editor nano
+ $ git config --global color.status auto
+ $ git config --global color.branch auto
+ $ git config --global color.interactive auto
+ $ git config --global color.diff auto +

+

+ Clone the git repository, and make your desired changes. You can make one or several commits (as many as you like). + Generally speaking, you should create separate commits on top of each other, for each kind of change. +

+

+ Once you have made your change(s), you can use this to check the status:
+ $ git status +

+

+ The status command will show any untracked files that you have. Add them using 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 +

+

+ If you need to make a change to the current commit, you can do so with:
+ $ git commit --amend
+ or:
+ $ git commit -a --amend +

+

+ In your local git tree, you can use this to check your commits:
+ $ git log +

+

+ Shortened git logs showing the short commit ID and the commit title, plus info about what branch + you are on, and where all your remotes/heads are:
+ $ git config --global --add alias.lol "log --graph --decorate --pretty=oneline --abbrev-commit --all"
+ From then on, you can use:
+ $ git lol
+ This is like git log, but on steroids. +

+

Method 1: host a repository

+

+ One way of contribiting a patch for review is to host a repository containing your modified branch. + Give the checkout details to the project, along with information + on which commits in what branch contain your changes. + Contact the project using the details on the home page. +

+

Method 2: git format-patch -N

+

+ Use this method (replace N with the number of commits that you made) and send the .patch files to the + project, along with details on what branch and revision these were + made on top of. + Contact the project using the details on the home page. +

+ +

Backup repositories

+

+ Generally speaking, you should use the main repositories. These repositories are provided + as backups, in case the main repositories are down.

Firmware (coreboot distribution)

@@ -232,7 +299,7 @@ ?>

-

Project website

+

website