doc: Add recommendations for good origin URLs.
authorPierre Neidhardt <mail@ambrevar.xyz>
Wed, 10 Oct 2018 16:06:08 +0000 (18:06 +0200)
committerPierre Neidhardt <mail@ambrevar.xyz>
Wed, 10 Oct 2018 16:06:08 +0000 (18:06 +0200)
* doc/contributing.texi (Submitting Patches): URL recommendations.

doc/contributing.texi

index 68d8e7e..91a87ef 100644 (file)
@@ -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