HCoop / jackhill / guix / guix.git / blame
| Commit | Line | Data |
|---|---|---|
| 450ccdc3 LC |
1 | -*- mode: org; coding: utf-8; -*- |
| 2 | ||
| 08ba7ff3 | 3 | #+TITLE: Hacking GNU Guix and Its Incredible Distro |
| 450ccdc3 | 4 | |
| 20e29643 | 5 | Copyright © 2012, 2013, 2014, 2016 Ludovic Courtès <ludo@gnu.org> |
| 8c01b9d0 | 6 | Copyright © 2015 Mathieu Lirzin <mthl@openmailbox.org> |
| 450ccdc3 LC |
7 | |
| 8 | Copying and distribution of this file, with or without modification, | |
| 9 | are permitted in any medium without royalty provided the copyright | |
| 10 | notice and this notice are preserved. | |
| 11 | ||
| 8c01b9d0 | 12 | * Contributing |
| 450ccdc3 | 13 | |
| 8c01b9d0 | 14 | See the manual for useful hacking informations, either by running |
| 84dbbc76 | 15 | |
| 8c01b9d0 | 16 | info -f doc/guix.info "(guix) Contributing" |
| 8b2d9e5d | 17 | |
| 8c01b9d0 | 18 | or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Contributing][web copy of the manual]]. |
| e1c5a835 | 19 | |
| 9bf3c1a7 LC |
20 | * Commit Access |
| 21 | ||
| 22 | For frequent contributors, having write access to the repository is | |
| 23 | convenient. When you deem it necessary, feel free to ask for it on the | |
| 24 | mailing list. When you get commit access, please make sure to follow the | |
| 2d2ad989 | 25 | policy below (discussions of the policy can take place on guix-devel@gnu.org.) |
| 9bf3c1a7 | 26 | |
| 2d2ad989 | 27 | Non-trivial patches should always be posted to guix-devel@gnu.org (trivial |
| 9bf3c1a7 LC |
28 | patches include fixing typos, etc.) |
| 29 | ||
| 30 | For patches that just add a new package, and a simple one, it’s OK to commit, | |
| e20ec9cc LC |
31 | if you’re confident (which means you successfully built it in a chroot setup, |
| 32 | and have done a reasonable copyright and license auditing.) Likewise for | |
| d0c64188 LC |
33 | package upgrades, except upgrades that trigger a lot of rebuilds (for example, |
| 34 | upgrading GnuTLS or GLib.) We have a mailing list for commit notifications | |
| e20ec9cc LC |
35 | (guix-commits@gnu.org), so people can notice. Before pushing your changes, |
| 36 | make sure to run ‘git pull --rebase’. | |
| 9bf3c1a7 | 37 | |
| 20e29643 LC |
38 | All commits that are pushed to the central repository on Savannah must be |
| 39 | signed with an OpenPGP key, and the public key should be uploaded to your user | |
| 40 | account on Savannah and to public key servers, such as ‘pgp.mit.edu’. To | |
| 41 | configure Git to automatically sign commits, run: | |
| 42 | ||
| 43 | git config commit.gpgsign true | |
| 44 | git config user.signingkey CABBA6EA1DC0FF33 | |
| a16db014 | 45 | |
| 2d2ad989 | 46 | For anything else, please post to guix-devel@gnu.org and leave time for a |
| 9bf3c1a7 LC |
47 | review, without committing anything. If you didn’t receive any reply |
| 48 | after two weeks, and if you’re confident, it’s OK to commit. | |
| 49 | ||
| 50 | That last part is subject to being adjusted, allowing individuals to commit | |
| 51 | directly on non-controversial changes on parts they’re familiar with. |