Problem Report Handling Guidelines (pr-guidelines): correct and update, or archive

[• grahamperrin]

Summary

Pull request

pr-guidelines: begin corrections and updates by grahamperrin · Pull Request #100 · freebsd/freebsd-doc

Background and decision-making

Bug Reports | The FreeBSD Project describes Problem Report Handling Guidelines as useful background information.

For FreeBSD Bugzilla as is: so much of the article is wrong, I can not describe it as useful.

Either:

1. make the article correct and useful (PR 100 above); or
2. archive the article, cease mentioning it at pages such as Bug Reports, and abandon this revision.

Cross-reference:

• FreeBSD bug 268311 – Bug fields: status and resolution.

See also:

• Writing FreeBSD Problem Reports | FreeBSD Documentation Portal
• Bugzilla - FreeBSD Wiki and its ten sub-pages (some overlap with the list of six resources)
• …

Origin of diff 114047 a.k.a. Diff 1:

• https://patch-diff.githubusercontent.com/raw/freebsd/freebsd-doc/pull/100.diff.

Test Plan

Preview in GitHub:

• https://github.com/grahamperrin/freebsd-doc/blob/bugzilla-git/documentation/content/en/articles/pr-guidelines/_index.adoc.

[pauamma_chezdork.com]

documentation/content/en/articles/pr-guidelines/_index.adoc

72

"follow-up" here, but "followup" above. I'd use one consistently. (Probably "followup" because it occurs much more often.)

109

Noting that the status for a patch needing MFC is "patched" here but "Needs MFC" above in the usecase story.

447

While here, I'd mention that checking https://cgit.freebsd.org/src/tree/share/misc/committers-{doc,ports,src}.dot is a good way to check which commit bit(s) someone has.

508

While here, no dash. Either "website" or "web site".

513

Missing )

[• grahamperrin]

archive the article, cease mentioning it at pages such as Bug Reports, and abandon this revision.

I'll leave a closing note in the underlying PR.

@pauamma_gundo.com: thanks.

[• grahamperrin]

From https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=273207#c27:

For reference: https://docs.freebsd.org/en/articles/pr-guidelines/

"Jane Random BugBuster …

[• grahamperrin]

FreeBSD bug 274342 – Bug reports in Bugzilla for FreeBSD do not begin in the open state, and the Problem Report Handling Guidelines article should be archived