Differential D2092 Diff 4276 en_US.ISO8859-1/articles/problem-reports/article.xml

Changeset View

Standalone View

en_US.ISO8859-1/articles/problem-reports/article.xml

Show First 20 Lines • Show All 95 Lines • ▼ Show 20 Lines	<para>So how does one determine what is a bug and what is not? As
a simple rule of thumb, the problem is <emphasis>not</emphasis>		a simple rule of thumb, the problem is <emphasis>not</emphasis>
a bug if it can be expressed as a question (usually of the form		a bug if it can be expressed as a question (usually of the form
<quote>How do I do X?</quote> or <quote>Where can I find		<quote>How do I do X?</quote> or <quote>Where can I find
Y?</quote>). It is not always quite so black and white, but the		Y?</quote>). It is not always quite so black and white, but the
question rule covers a large majority of cases. When looking		question rule covers a large majority of cases. When looking
for an answer, consider posing the question to the		for an answer, consider posing the question to the
&a.questions;.</para>		&a.questions;.</para>

<para>Some cases where it may be appropriate to submit a problem		<para>When submitting a PR about software not written by FreeBSD
		wblockUnsubmitted Not Done Inline Actions s/FreeBSD/&os;/ wblock: s/FreeBSD/&os;/
report about something that is not a bug are:</para>		contributors (such as ports), consider the following:</para>
		wblockUnsubmitted Not Done Inline Actions The aside makes this confusing, and it's hard to tell what this sentence means. I think it means this: Consider these factors when submitting PRs about ports or other software that is not part of &os; itself: wblock: The aside makes this confusing, and it's hard to tell what this sentence means. I think it…

<itemizedlist>		<itemizedlist>
<listitem>		<listitem>
<para>Notification of updates to externally maintained
software (such as ports or software in the contrib/
directory).</para>

<para>For unmaintained ports (<varname>MAINTAINER</varname>		<para>For unmaintained ports (<varname>MAINTAINER</varname>
contains <literal>ports@FreeBSD.org</literal>), such update		contains <literal>ports@FreeBSD.org</literal>),
notifications might get picked up by an interested		a PR about a new update
		might get picked up by an interested
		wblockUnsubmitted Not Done Inline Actions The "feel free" can be taken as kind of passive-aggressive. Could be Actual patches to update a port to a newer version are welcome. wblock: The "feel free" can be taken as kind of passive-aggressive. Could be Actual patches to update…
committer, or you might be asked to provide a patch to		committer, or you might be asked to provide a patch to
update the port; providing it upfront will greatly improve		update the port; providing it upfront will greatly improve
your chances that the port will get updated in a timely		the chances that the port will get updated in a timely
manner.</para>		manner.</para>
		</listitem>

		<listitem>
<para>If the port is maintained, PRs announcing new upstream		<para>If the port is maintained, PRs announcing new upstream
releases are usually not very useful since they generate		releases are usually not very helpful since maintainers
		wblockUnsubmitted Not Done Inline Actions This is a run-on sentence. Break it after "helpful": ...helpful. Maintainers... wblock: This is a run-on sentence. Break it after "helpful": ...helpful. Maintainers...
supplementary work for the committers, and the maintainer		are automatically notified by
likely knows already there is a new version, they have		<application>portscout</application>, which automatically
		wblockUnsubmitted Not Done Inline Actions This second "automatically" is redundant. wblock: This second "automatically" is redundant.
		wblockUnsubmitted Not Done Inline Actions s/If you would like to/To/ wblock: s/If you would like to/To/
probably worked with the developers on it, they are probably		tracks new versions of applications, and so a PR would only
		wblockUnsubmitted Not Done Inline Actions Passive->active: s/would only create/only creates/ Split sentences apart: applications. So a PR only creates wblock: Passive->active: s/would only create/only creates/ Split sentences apart: applications. So a…
		marinoUnsubmitted Not Done Inline Actions suggest changing from: "of an application, contact &a.ports;" to "of an unmaintained port, submit a PR with the request (patch preferred but not required)" I think we prefer "make me maintainer" requests via bugzilla over mail list, and we definitely want to be sure any new maintainer has a bugzilla account as a minimum requirement to be a maintainer. marino: suggest changing from: "of an application, contact &a.ports;" to "of an unmaintained port…
testing to see there is no regression, etc.</para>		create supplementary work for the committers.</para>
		wblockUnsubmitted Not Done Inline Actions "Supplementary" has a positive connotation. "needless additional" is better. "the committers" can just be "committers". wblock: "Supplementary" has a positive connotation. "needless additional" is better. "the committers"…
		</listitem>
		wblockUnsubmitted Not Done Inline Actions s/contains/is/ wblock: s/contains/is/

		<listitem>
<para>In either case, following the process described in <link		<para>In either case, following the process described in <link
xlink:href="&url.books.porters-handbook;/port-upgrading.html">Porter's		xlink:href="&url.books.porters-handbook;/port-upgrading.html">Porter's
Handbook</link> will yield the best results. (You might		Handbook</link> will yield the best results. (You might
also wish to read <link		also wish to read <link
xlink:href="&url.articles.contributing-ports;/article.html">Contributing		xlink:href="&url.articles.contributing-ports;/article.html">Contributing
to the FreeBSD Ports Collection</link>.)</para>		to the FreeBSD Ports Collection</link>.)</para>
</listitem>		</listitem>
</itemizedlist>		</itemizedlist>
▲ Show 20 Lines • Show All 1,097 Lines • Show Last 20 Lines