[SeaBIOS] [PATCH] docs: Add page describing the patch contribution process

Kevin O'Connor kevin at koconnor.net
Thu Feb 19 01:12:47 CET 2015

Signed-off-by: Kevin O'Connor <kevin at koconnor.net>

I think it would be worthwhile to document the process of contributing
patches to SeaBIOS.  However, I don't really want to duplicate all the
useful information already available on other projects.  In
particular, the QEMU wiki documentation for patch submission is quite
good.  So, this patch adds a new SeaBIOS document which basically just
points users to the QEMU wiki page.

 docs/Contributing.md            | 20 ++++++++++++++++++++
 docs/Developer_Documentation.md |  3 ++-
 2 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 docs/Contributing.md

diff --git a/docs/Contributing.md b/docs/Contributing.md
new file mode 100644
index 0000000..d0f2b5b
--- /dev/null
+++ b/docs/Contributing.md
@@ -0,0 +1,20 @@
+SeaBIOS welcomes contributions of code (either fixing bugs or adding
+new functionality). At a high level, the process to contribute a
+change is:
+1. [Obtain](Download) the current code and documentation
+2. Enhance and test the code locally
+3. Submit changes to the SeaBIOS [mailing list](Mailinglist) as a
+   patch
+4. Receive feedback, answer questions, and possibly provide updated
+   patches
+5. When accepted, a maintainer (Kevin O'Connor or Gerd Hoffman) will
+   commit the change to the master SeaBIOS repository
+The SeaBIOS patch submission process is similar to the
+[QEMU process](http://wiki.qemu.org/Contribute/SubmitAPatch). Please
+review the QEMU process for more details and tips on the best way to
+submit patches. The SeaBIOS C code does follow a slightly different
+coding style from QEMU (eg, mixed code and C99 style variable
+declarations are encouraged, braces are not required around single
+statement blocks), however patches in the QEMU style are acceptable.
diff --git a/docs/Developer_Documentation.md b/docs/Developer_Documentation.md
index d50455d..843d612 100644
--- a/docs/Developer_Documentation.md
+++ b/docs/Developer_Documentation.md
@@ -18,7 +18,8 @@ A description of the process of linking the final SeaBIOS binary is
 available at [Linking overview](Linking overview).
 To debug SeaBIOS and report problems see SeaBIOS
+[debugging](Debugging). To contribute changes to SeaBIOS see
 Useful links to specifications is available at [Developer
 links](Developer links).

More information about the SeaBIOS mailing list