diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2015-02-18 19:02:56 -0500 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2015-02-18 19:02:56 -0500 |
| commit | 39ac00df842192490f719d682a550631527f95dd (patch) | |
| tree | 3a56df604a65cfa8825c6f4d9ae68d6f7a823bf0 /docs | |
| parent | 3c21f3486691bbcbe0647fb141dd3382e592feb1 (diff) | |
| download | seabios-hppa-39ac00df842192490f719d682a550631527f95dd.zip seabios-hppa-39ac00df842192490f719d682a550631527f95dd.tar.gz seabios-hppa-39ac00df842192490f719d682a550631527f95dd.tar.bz2 | |
docs: Add page describing the patch contribution process
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Contributing.md | 20 | ||||
| -rw-r--r-- | docs/Developer_Documentation.md | 3 |
2 files changed, 22 insertions, 1 deletions
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). +[debugging](Debugging). To contribute changes to SeaBIOS see +[contributing](Contributing). Useful links to specifications is available at [Developer links](Developer links). |