libreboot

my branch of libreboot
git clone git://git.hazbo.co.uk/libreboot.git
Log | Files | Refs | README

git.md (3824B)


      1 ---
      2 title: Information about sending patches for review
      3 x-toc-enable: true
      4 ...
      5 
      6 Download Libreboot from the Git repository like so:
      7 
      8     $ git clone https://notabug.org/libreboot/libreboot.git
      9 
     10 You can submit your patches via
     11 [Notabug pull requests](#how-to-submit-your-patches-via-pull-requests).
     12 
     13 Information about how the Libreboot project is governed is documented in our
     14 [general management guidelines](management.md).
     15 
     16 Libreboot development is done using the Git version control system.
     17 Refer to the [official Git documentation](https://git-scm.com/doc) if you don't
     18 know how to use Git.
     19 
     20 Editing the website and documentation, wiki-style
     21 -------------------------------------------------
     22 
     23 The website and documentation is inside the `www` directory in the
     24 [Git repository](#how-to-download-libreboot-from-the-git-repository), in
     25 Pandoc flavoured Markdown. The website is generated into static HTML via Pandoc
     26 with the following scripts in that directory:
     27 
     28 - index.sh: generates the news feed (on the News section of the website)
     29 - publish.sh: converts an .md file to an .html file
     30 - Makefile: with calls to index.sh and publish.sh, compiles the entire
     31   Libreboot website
     32 
     33 Use any standard text editor (e.g. Vim, Emacs, Nano, Gedit) to edit the files,
     34 commit the changes and
     35 [send patches](#how-to-submit-your-patches-via-pull-requests).
     36 
     37 Optionally, you can install a web server (e.g. lighttpd, nginx) locally and
     38 set the document root to the *www* directory in your local Git repository.
     39 With this configuration, you can then generate your local version of the
     40 website and view it by typing `localhost` in your browser's URL bar.
     41 
     42 General guidelines for submitting patches
     43 -----------------------------------------
     44 
     45 We require all patches to be submitted under a free license:
     46 <https://www.gnu.org/licenses/license-list.html>.
     47 
     48 - GNU General Public License v3 is highly recommended
     49 - For documentation, we require GNU Free Documentation License v1.3 or higher
     50 
     51 *Always* declare a license on your work! Not declaring a license means that
     52 the default, restrictive copyright laws apply, which would make your work
     53 non-free.
     54 
     55 GNU+Linux is generally recommended as the OS of choice, for Libreboot
     56 development.
     57 
     58 General code review guidelines
     59 ------------------------------
     60 
     61 Any member of the public can
     62 [submit a patch](#how-to-submit-your-patches-via-pull-requests).
     63 Members with push access must *never* push directly to the master branch;
     64 issue a Pull Request, and wait for someone else to merge. Never merge your own
     65 work!
     66 
     67 Your patch will be reviewed for quality assurance, and merged if accepted.
     68 
     69 How to download Libreboot from the Git repository
     70 -------------------------------------------------
     71 
     72 In your terminal:
     73 
     74     $ git clone https://notabug.org/libreboot/libreboot.git
     75 
     76 A new directory named `libreboot` will have been created, containing
     77 libreboot.
     78 
     79 How to submit your patches (via pull requests)
     80 ----------------------------------------------
     81 
     82 Make an account on <https://notabug.org/> and navigate (while logged in) to
     83 <https://notabug.org/libreboot/libreboot>. Click *Fork* and in your account,
     84 you will have your own repository of Libreboot. Clone your repository, make
     85 whatever changes you like to it and then push to your repository, in your
     86 account on NotABug.
     87 
     88 Now, navigate to <https://notabug.org/libreboot/libreboot/pulls> and click
     89 *New Pull Request*. 
     90 
     91 You can submit your patches there. Alternative, you can log onto the Libreboot
     92 IRC channel and notify the channel of which patches you want reviewed, if you
     93 have your own Git repository with the patches.
     94 
     95 Once you have issued a Pull Request, the Libreboot maintainers will be notified
     96 via email. If you do not receive a fast enough response from the project, then
     97 you could also notify the project via the #libreboot channel on Freenode.