UIReviews

(Difference between revisions)
Line 7: Line 7:
These are the '''roles''' that different people play in reviews:
These are the '''roles''' that different people play in reviews:
-
'''Submitter:''' the person proposing UI change and asking for review <br />Submitter's task is to prepare information for review, properly announce it, drive the review procedure, answer questions during review via mail/Bugzilla.
+
'''Submitter:''' the person proposing UI change and asking for review. Submitter's task is to prepare information for review, properly announce it, drive the review procedure, answer questions during review via mail/Bugzilla.
-
'''Reviewers:''' people assigned or chosen by the reviewer to do the review <br />Reviewers need to study the issue and provide feedback and final decision in a timely fashion.
+
'''Reviewers:''' people assigned or chosen by the reviewer to do the review (most likely members of the UI Steering team). Reviewers need to study the issue and provide feedback and final decision in a timely fashion.
-
'''Reviewers Chair:''' lead of reviewers group <br />Not needed. At least not needed if things go well. In case of a dispute, chair is the one to find and decide on acceptable resolution.
+
'''Reviewers Chair:''' lead of reviewers group. Not needed. At least not needed if things go well. In case of a dispute, chair is the one to find and decide on acceptable resolution.
==Step 1 - Prepare Materials==
==Step 1 - Prepare Materials==
Before a review can be requested the submitter has to prepare documentation that is supposed to be reviewed.
Before a review can be requested the submitter has to prepare documentation that is supposed to be reviewed.
-
'''Submitter:''' Creates an Bugzilla issue filed under Bugzilla component related to the UI as any other bug related to the area (if the submitter can't determine the right component for some reason, the issue should be filed under '''ide / UI'''). The submitter has to include links to materials for review:
+
'''Submitter:''' Create an Bugzilla issue filed under a component related to the UI as any other bug related to the area (if the submitter can't determine the right component for some reason, the issue should be filed under '''ide / UI'''). The submitter has to include links to materials for review:
* for larger problems the best way is to setup easily editable [http://wiki.netbeans.org '''wiki'''] page containing all related details
* for larger problems the best way is to setup easily editable [http://wiki.netbeans.org '''wiki'''] page containing all related details
* or attach '''screenshot(s)''' with description for smaller problems (minor UI changes, small dialogs, ...)
* or attach '''screenshot(s)''' with description for smaller problems (minor UI changes, small dialogs, ...)
-
The issue should include the following information:
+
The issue should also include the following information:
* A short issue description outlining what the issue is and why it is being done.
* A short issue description outlining what the issue is and why it is being done.
Line 28: Line 28:
==Step 2 - Submit the Issue==
==Step 2 - Submit the Issue==
-
'''Submitter:''' Starts a review by CCing or reassigning the issue to ''uireviews@netbeans.org'' and adding '''UI_REVIEW''' keyword.
+
'''Submitter:''' Start a review by CCing or reassigning the issue to ''uireviews@netbeans.org'' and adding '''UI_REVIEW''' keyword.
==Step 3 - Review==
==Step 3 - Review==
-
'''Reviewers:''' Every reviewer is expected to review the issue. They can ask questions, discuss the issue with submitter or within reviewers group if needed. As a result of their review, they can propose changes if needed.
+
'''Reviewers:''' Every reviewer is expected to review the issue. They can ask questions, discuss the issue with submitter or within reviewers group and  propose changes if needed.
-
'''Submitter:''' wait for the review period, if there are questions (proposed changes) resolve them.
+
'''Submitter:''' Wait for the review period, if there are questions (proposed changes) resolve them.
==Step 4 - The Decision==
==Step 4 - The Decision==
 +
 +
'''Reviewers:''' In extreme cases reviewers can reject reviewed UI completely and resolve the issue as ''WONTFIX''.
'''Submitter:''' After all questions and objections are resolved, the submitter should wait 24 hours before committing the solution to trunk to give reviewers last chance to comment. After that, he can close the issue.
'''Submitter:''' After all questions and objections are resolved, the submitter should wait 24 hours before committing the solution to trunk to give reviewers last chance to comment. After that, he can close the issue.

Revision as of 15:59, 12 November 2012

Contents

Purpose of UI Reviews

UI Review is an interactive online process that provides recommendations and guidance for UI design of a new feature or a change of the existing feature. The goal of UI Reviews is to supervise the design of NetBeans IDE and other products based on NetBeans and provide help and suggestions during the reviews.


UI Review - Steps

These are the roles that different people play in reviews:

Submitter: the person proposing UI change and asking for review. Submitter's task is to prepare information for review, properly announce it, drive the review procedure, answer questions during review via mail/Bugzilla.

Reviewers: people assigned or chosen by the reviewer to do the review (most likely members of the UI Steering team). Reviewers need to study the issue and provide feedback and final decision in a timely fashion.

Reviewers Chair: lead of reviewers group. Not needed. At least not needed if things go well. In case of a dispute, chair is the one to find and decide on acceptable resolution.

Step 1 - Prepare Materials

Before a review can be requested the submitter has to prepare documentation that is supposed to be reviewed.

Submitter: Create an Bugzilla issue filed under a component related to the UI as any other bug related to the area (if the submitter can't determine the right component for some reason, the issue should be filed under ide / UI). The submitter has to include links to materials for review:

  • for larger problems the best way is to setup easily editable wiki page containing all related details
  • or attach screenshot(s) with description for smaller problems (minor UI changes, small dialogs, ...)

The issue should also include the following information:

  • A short issue description outlining what the issue is and why it is being done.
  • Target milestone
  • Dependencies on other issues and issues that depend on this one

Step 2 - Submit the Issue

Submitter: Start a review by CCing or reassigning the issue to uireviews@netbeans.org and adding UI_REVIEW keyword.

Step 3 - Review

Reviewers: Every reviewer is expected to review the issue. They can ask questions, discuss the issue with submitter or within reviewers group and propose changes if needed.

Submitter: Wait for the review period, if there are questions (proposed changes) resolve them.

Step 4 - The Decision

Reviewers: In extreme cases reviewers can reject reviewed UI completely and resolve the issue as WONTFIX.

Submitter: After all questions and objections are resolved, the submitter should wait 24 hours before committing the solution to trunk to give reviewers last chance to comment. After that, he can close the issue.


Queries

Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo