summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorPierre Neidhardt <mail@ambrevar.xyz>2018-10-10 18:06:08 +0200
committerPierre Neidhardt <mail@ambrevar.xyz>2018-10-10 18:06:08 +0200
commit4feb589bf48cbbd2d524002456fa822acf856bc3 (patch)
treebb0e4cc6beeb9c38e6e0c872df7905faccfcd71c /doc
parent8f3dc810b18280052fed56090a1f8034f7b5b008 (diff)
downloadguix-4feb589bf48cbbd2d524002456fa822acf856bc3.tar.gz
doc: Add recommendations for good origin URLs.
* doc/contributing.texi (Submitting Patches): URL recommendations.
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 68d8e7e2fb..91a87ef2dd 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -468,6 +468,14 @@ Please follow our code formatting rules, possibly running the
 @command{etc/indent-code.el} script to do that automatically for you
 (@pxref{Formatting Code}).
 
+@item
+When possible, use mirrors in the source URL (@pxref{Invoking guix download}).
+Use reliable URLs, not generated ones.  For instance, GitHub archives are not
+necessarily identical from one generation to the next, so in this case it's
+often better to clone the repository.  Don't use the @command{name} field in
+the URL: it is not very useful and if the name changes, the URL will probably
+be wrong.
+
 @end enumerate
 
 When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as