summary refs log tree commit diff
path: root/HACKING
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2014-09-03 10:41:13 +0200
committerLudovic Courtès <ludo@gnu.org>2014-09-03 15:43:07 +0200
commit141360b5b257715fdca2db4fc106b4220788ae06 (patch)
tree6056923604dd4d1507e7e8ef77326c13b8beb305 /HACKING
parentb002e9d08eb909e9fa1a84b0feed1662dce0bd3f (diff)
downloadguix-141360b5b257715fdca2db4fc106b4220788ae06.tar.gz
doc: Mention 'guix lint' and '--list-dependent' in 'HACKING'.
* HACKING (Submitting Patches): Mention 'guix lint' and 'guix refresh
  --list-dependent'.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING7
1 files changed, 7 insertions, 0 deletions
diff --git a/HACKING b/HACKING
index 9e47b9703b..0231c7d84d 100644
--- a/HACKING
+++ b/HACKING
@@ -89,6 +89,13 @@ in the form of patches as produced by ‘git format-patch’ sent to
 guix-devel@gnu.org.  Please write commit logs in the [[http://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs][GNU ChangeLog
 format]]; you can check the commit history for examples.
 
+Before submitting a patch that adds or modifies a package definition, please
+run ‘guix lint PACKAGE’, where PACKAGE is the name of the new or modified
+package, and fix any errors it reports.  In addition, please make sure the
+package builds on your platform, using ‘guix build’.  You may also want to
+check that dependent package (if applicable) are not affected by the change;
+‘guix refresh --list-dependent PACKAGE’ will help you do that.
+
 When posting a patch to the mailing list, use "[PATCH] ..." as a subject.  You
 may use your email client or the ‘git send-mail’ command.