diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2015-09-15 22:37:12 +0200 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2015-09-15 22:48:52 +0200 |
| commit | cbd02397b523e167c7db9775eee1be71f110482c (patch) | |
| tree | bb6589d5a5f9ce9a749e46511fdb2160d64eafc1 /doc/contributing.texi | |
| parent | 2cbed07eef96648948cfec2e225b9dfe6f08d72c (diff) | |
| download | guix-cbd02397b523e167c7db9775eee1be71f110482c.tar guix-cbd02397b523e167c7db9775eee1be71f110482c.tar.gz | |
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.
Diffstat (limited to 'doc/contributing.texi')
| -rw-r--r-- | doc/contributing.texi | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index 7b16ea3539..ded54348bc 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -207,6 +207,10 @@ 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 (@pxref{Invoking guix lint}). |