Remove text about including text such as [patch] or [maintainer update]
in the Synopsis. This has been bad advice for a number of years. The Keywords field has supplanted this. This article is still very, very, stale and needs more work. Reported by: koobs
This commit is contained in:
parent
6d06632c28
commit
31000fe084
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=53147
1 changed files with 3 additions and 15 deletions
|
@ -328,19 +328,14 @@
|
|||
<listitem>
|
||||
<para><emphasis>If you have a patch, say so.</emphasis>
|
||||
A PR with a patch included is much more likely to be
|
||||
looked at than one without. If you are including one, put
|
||||
the string <literal>[patch]</literal> (including the
|
||||
brackets) at the beginning of the <quote>Synopsis</quote>.
|
||||
(Although it is not mandatory to use that exact string, by
|
||||
convention, that is the one that is used.)</para>
|
||||
looked at than one without. Please set the
|
||||
<literal>patch</literal> Keyword in Bugzilla.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><emphasis>If you are a maintainer, say so.</emphasis>
|
||||
If you are maintaining a part of the source code (for
|
||||
instance, a port), you might consider adding the string
|
||||
<literal>[maintainer update]</literal> (including the
|
||||
brackets) at the beginning of your synopsis line, and you
|
||||
instance, an existing port), you
|
||||
definitely should set the <quote>Class</quote> of your PR
|
||||
to <literal>maintainer-update</literal>. This way any
|
||||
committer that handles your PR will not have to
|
||||
|
@ -611,13 +606,6 @@
|
|||
email, and is used in problem report listings and
|
||||
summaries; problem reports with obscure synopses tend to
|
||||
get ignored.</para>
|
||||
|
||||
<para>As noted above, if your problem report includes a
|
||||
patch, please have the synopsis start with
|
||||
<literal>[patch]</literal> (including the brackets); if
|
||||
this is a ports PR and you are the maintainer, you may
|
||||
consider adding <literal>[maintainer update]</literal>
|
||||
(including the brackets).</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
|
|
Loading…
Reference in a new issue