doc: Add recommendations for good origin URLs.

* doc/contributing.texi (Submitting Patches): URL recommendations.
This commit is contained in:
Pierre Neidhardt 2018-10-10 18:06:08 +02:00
parent 8f3dc810b1
commit 4feb589bf4
No known key found for this signature in database
GPG Key ID: 9BDCF497A4BBCC7F
1 changed files with 8 additions and 0 deletions

View 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 @command{etc/indent-code.el} script to do that automatically for you
(@pxref{Formatting Code}). (@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 @end enumerate
When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as