From cbd02397b523e167c7db9775eee1be71f110482c Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Tue, 15 Sep 2015 22:37:12 +0200 Subject: doc: Add guidelines for synopses and descriptions. * doc/guix.texi (Synopses and Descriptions): New node. * doc/contributing.texi (Submitting Patches): Add item that cross-references it. --- doc/contributing.texi | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/contributing.texi') diff --git a/doc/contributing.texi b/doc/contributing.texi index 7b16ea3539..ded54348bc 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -206,6 +206,10 @@ Before submitting a patch that adds or modifies a package definition, please run through this check list: @enumerate +@item +Take some time to provide an adequate synopsis and description for the +package. @xref{Synopses and Descriptions}, for some guidelines. + @item Run @code{guix lint @var{package}}, where @var{package} is the name of the new or modified package, and fix any errors it reports -- cgit v1.2.3