From owner-svn-doc-all@FreeBSD.ORG Sun Jun 29 07:40:16 2014 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id B1467C19; Sun, 29 Jun 2014 07:40:16 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 9E603214F; Sun, 29 Jun 2014 07:40:16 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s5T7eGnG064520; Sun, 29 Jun 2014 07:40:16 GMT (envelope-from eadler@svn.freebsd.org) Received: (from eadler@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s5T7eGRG064519; Sun, 29 Jun 2014 07:40:16 GMT (envelope-from eadler@svn.freebsd.org) Message-Id: <201406290740.s5T7eGRG064519@svn.freebsd.org> From: Eitan Adler Date: Sun, 29 Jun 2014 07:40:16 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45145 - head/en_US.ISO8859-1/articles/pr-guidelines X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 29 Jun 2014 07:40:16 -0000 Author: eadler Date: Sun Jun 29 07:40:16 2014 New Revision: 45145 URL: http://svnweb.freebsd.org/changeset/doc/45145 Log: Partially convert the pr-guidelines article to the bugzilla world. This is intentionally incomplete as the bugzilla states and categories are not yet firm, and requires more precise wordsmihing. Modified: head/en_US.ISO8859-1/articles/pr-guidelines/article.xml Modified: head/en_US.ISO8859-1/articles/pr-guidelines/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/pr-guidelines/article.xml Sun Jun 29 07:40:14 2014 (r45144) +++ head/en_US.ISO8859-1/articles/pr-guidelines/article.xml Sun Jun 29 07:40:16 2014 (r45145) @@ -36,14 +36,14 @@
Introduction - GNATS is a defect management (bug reporting) system used by - the FreeBSD Project. As accurate tracking of outstanding + Bugzilla is an issue management system used by + the &os; Project. As accurate tracking of outstanding software defects is important to FreeBSD's quality, the - correct use of GNATS is essential to the forward progress of the - Project. + correct use of the software is essential to the forward + progress of the Project. - Access to GNATS is available to FreeBSD developers, as well as - to the wider community. In order to maintain consistency within + Access to Bugzilla is available to the entire &os; + community. In order to maintain consistency within the database and provide a consistent user experience, guidelines have been established covering common aspects of bug management such as presenting followup, handling close requests, and so @@ -55,30 +55,37 @@ - The Reporter submits a PR with &man.send-pr.1; and - receives a confirmation message. + The Reporter submits a bug report on the website. The + bug is in the Needs Triage state. + + + + Jane Random BugBuster confirms that the bug report has + sufficient information to be reproducible. If not, she goes + back and forth with the reporter to obtain the needed + information. At this point the bug is set to the + Open state. Joe Random Committer takes interest in the PR and assigns it to himself, or Jane Random BugBuster decides that Joe is best suited to handle it and assigns it to - him. + him. The bug should be set to the In + Discussion state. Joe has a brief exchange with the originator (making sure it all goes into the audit trail) and determines the - cause of the problem. He then makes sure the cause is - documented in the audit trail, and sets the PRs state to - analyzed. + cause of the problem. Joe pulls an all-nighter and whips up a patch that he thinks fixes the problem, and submits it in a follow-up, asking the originator to test it. He then sets the PRs - state to feedback. + state to Patch Ready. @@ -89,19 +96,15 @@ -CURRENT), making sure to reference the Problem Report in his commit log (and credit the originator if he submitted all or part of the patch) and, if - appropriate, start an MFC countdown. + appropriate, start an MFC countdown. The bug is set to the + Needs MFC state. If the patch does not need MFCing, Joe then closes the - PR. + PR as Issue Resolved. - - If the patch needs MFCing, Joe leaves the Problem Report - in patched state until the patch has been - MFCed, then closes it. - @@ -113,14 +116,6 @@ cannot be solved, or has occurred again, it is necessary to re-open the PR. - - The email address used on the PR might not - be able to receive mail. In this case, followup to the PR as - usual and ask the originator (in the followup) to provide a - working email address. This is normally the case when - &man.send-pr.1; is used from a system with the mail system - disabled or not installed. -
@@ -193,19 +188,6 @@ - repocopy (obsolete) - - The resolution of the problem report is dependent on a - repository copy, or repocopy, operation within the CVS - repository which is awaiting completion. - - Given that all repositories now use Subversion, there is - no need for this state anymore. Subversion has native - support for copying and moving files. - - - - closed A problem report is closed when any changes have been @@ -902,147 +884,34 @@ -
- Followups misfiled as new PRs - - The first category of misfiled PRs, the one with the wrong - subject header, is actually the one that requires the greatest - amount of work from developers. These are not real PRs, - describing separate problem reports. When a reply is received - for an existing PR at one of the addresses that GNATS - listens to for incoming messages, the subject - of the reply should always be of the form: - - Subject: Re: category/number: old synopsis text - - Most mailers will add the - Re:  part when you - reply to the original mail message of a PR. The - category/number:  part - is a GNATS-specific convention that you have to manually - insert to the subject of your followup reports. - - Any FreeBSD developer, who has direct access to the GNATS - database, can periodically check for PRs of this sort and move - interesting bits of the misfiled PR into the audit trail of - the original PR (by posting a proper followup to a bug report - to the address &a.bugfollowup;). Then - the misfiled PR can be closed with a message similar - to: - - Your problem report was misfiled. Please use the format -"Subject: category/number: original text" when following -up to older, existing PRs. I've added the relevant bits -from the body of this PR to kern/12345 - - Searching with query-pr for the - original PR, of which a misfiled followup is a reply, is as - easy as running: - - &prompt.user; query-pr -q -y "some text" - - After you locate the original PR and the misfiled - followups, use the option of - query-pr to save the full text of all the - relevant PRs in a &unix; mailbox file, i.e.: - - &prompt.user; query-pr -F 52458 52474 > mbox - - Now you can use any mail user agent to view all the PRs - you saved in mbox. Copy the text of all - the misfiled PRs in a followup to the original PR and make - sure you include the proper Subject: - header. Then close the misfiled PRs. When you close the misfiled - PRs remember that the submitter receives a mail notification that - his PR changed state to closed. Make sure you - provide enough details in the log about the reason of this state - change. Typically something like the following is ok: - - Followup to ports/45364 misfiled as a new PR. -This was misfiled because the subject did not have the format: - - Re: ports/45364: ... - - This way the submitter of the misfiled PR will know what to - avoid the next time a followup to an existing PR is sent. -
- -
- PRs misfiled because of missing fields - - The second type of misfiled PRs is usually the result of a - submitter forgetting to fill all the necessary fields when - writing the original PR. - - Missing or bogus category or - class fields can result in a misfiled report. - Developers can use &man.edit-pr.1; to change the category or - class of these misfiled PRs to a more appropriate value and - save the PR. - - Another common cause of misfiled PRs because of formatting - issues is quoting, changes or removal of the - send-pr template, either by the user who - edits the template or by mailers which do strange things to - plain text messages. This does not happen a lot of the time, - but it can be fixed with edit-pr too; it - does require a bit of work from the developer who refiles the - PR, but it is relatively easy to do most of the time. -
-
- Misfiled PRs that are not really problem reports - - Sometimes a user wants to submit a report for a problem - and sends a simple email message to GNATS. The GNATS scripts - will recognize bug reports that are formatted using the - &man.send-pr.1; template. They cannot parse any sort of email - though. This is why submissions of bug reports that are sent - to freebsd-gnats-submit@FreeBSD.org have to - follow the template of send-pr, but email - reports can be sent to &a.bugs;. + Non-Bug PRs Developers that come across PRs that look like they should have been posted to &a.bugs.name; or some other list should close the - PR, informing the submitter in their state-change log why this + PR, informing the submitter in a comment why this is not really a PR and where the message should be posted. - The email addresses that GNATS listens to for incoming PRs + The email addresses that Bugzilla listens to for incoming PRs have been published as part of the FreeBSD documentation, have been announced and listed on the web-site. This means that - spammers found them. Spam messages - that reach GNATS are promptly filed - under the pending category until someone looks - at them. Closing one of these with &man.edit-pr.1; is very - annoying though, because GNATS replies to the submitter and - the sender's address of spam mail is never valid these days. - Bounces will come back for each PR that is closed. - - Currently, with the installation of some antispam filters - that check all submissions to the GNATS database, the amount - of spam that reaches the pending state is very - small. - - All developers who have access to the FreeBSD.org cluster - machines are encouraged to check for misfiled PRs and immediately - close those that are spam mail. Whenever you close one of - these PRs, please do the following: + spammers found them. - - - Set Category to junk. - + Whenever you close one of these PRs, please do the + following: + - Set Confidential to no. + Set the component to junk (under + Supporting Services. - Set Responsible to gnats-admin. + Set Responsible to nobody@FreeBSD.org. - Set State to closed. + Set State to Issue Resolved.