Difference between revisions of "UI Best Practices Update Process"

From Eclipsepedia

Jump to: navigation, search
(Make a request)
m
 
(15 intermediate revisions by one user not shown)
Line 3: Line 3:
 
== Make a request ==
 
== Make a request ==
  
* We will use bugzilla to track the set of topics that people are working on.  Look there to see if the topic you wish to write or edit is already being work on.  This will tell give you a list of all open bugs against "UI Guidelines" https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Eclipse+Foundation&product=Community&component=UI+Guidelines&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED
+
* We will use bugzilla to track the set of topics that people are working on.  [http://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Eclipse+Foundation&product=Community&component=UI+Guidelines&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED Query bugzilla] to see if the topic you wish to write or edit is already being work on.
* File a bugzilla with component “UI Guidelines” (https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=UI%20Guidelines).
+
* [http://bugs.eclipse.org/bugs/enter_bug.cgi?product=Community&component=UI%20Guidelines File a bug against component UI Guidelines]
 
* Track the bug.  The bug will be the place where your submission is discussed, edits are suggested, etc.
 
* Track the bug.  The bug will be the place where your submission is discussed, edits are suggested, etc.
 +
* If you are suggestion or request isn't at that concrete a level, feel free to add some discussion text to the [[Talk:User_Interface_Guidelines]] page.
  
 
== Add your content ==
 
== Add your content ==
  
* Create a new wiki page linked to [[Talk:User_Interface_Guidelines]] and add your content.
+
* Minor Edits:
* Put a link to this page in your bug.
+
** If you are making minor edits (e.g. fixing typos or small inaccuracies) then do so in place.
* Here is a template that you can use for your content: [[UI Best Practices Template v3.x]]
+
** Make a comment in the bug with respect to the changes you've made.
 +
* Major Edits:
 +
** If you are creating a new section, or making extensive edits to an existing one, make a new wiki page linked from [[Talk:User_Interface_Guidelines]].  
 +
** Use the [[UI Best Practices Template v3.x | new 3.x template]]  
 +
** If you are editing an existing section, make a copy of it in a new page and edit from there.  This allows you to work in a sandbox.
 +
** The [[Talk:User_Interface_Guidelines]] page should list at the top all the pages being worked on.  Actual content should be on the working page or in a bug report.
 +
** Put a comment at the top of the existing page, "UNDER CONSTRUCTION bug #123" with the bug number.  This is a safeguard to ensure two people don't start making major edits to the same section and potentially either duplicate or lose work.
 +
** Put a link to this page in your bug.
  
 
== Have things reviewed ==
 
== Have things reviewed ==
Line 20: Line 28:
 
== Merge your changes into the drafts ==
 
== Merge your changes into the drafts ==
  
* Move your content from the sandbox to the draft pages here: [[UI Best Practices v3.x]]
+
* If after one week nobody has raised any objections to the changes, move your content from the sandbox to the draft pages here: [[UI Best Practices v3.x]]
 +
 
 +
[[Category:UI_Guidelines]]

Latest revision as of 12:43, 31 October 2007

Contents

[edit] Process for Updating the UI Best Practices Guidelines

[edit] Make a request

  • We will use bugzilla to track the set of topics that people are working on. Query bugzilla to see if the topic you wish to write or edit is already being work on.
  • File a bug against component UI Guidelines
  • Track the bug. The bug will be the place where your submission is discussed, edits are suggested, etc.
  • If you are suggestion or request isn't at that concrete a level, feel free to add some discussion text to the Talk:User_Interface_Guidelines page.

[edit] Add your content

  • Minor Edits:
    • If you are making minor edits (e.g. fixing typos or small inaccuracies) then do so in place.
    • Make a comment in the bug with respect to the changes you've made.
  • Major Edits:
    • If you are creating a new section, or making extensive edits to an existing one, make a new wiki page linked from Talk:User_Interface_Guidelines.
    • Use the new 3.x template
    • If you are editing an existing section, make a copy of it in a new page and edit from there. This allows you to work in a sandbox.
    • The Talk:User_Interface_Guidelines page should list at the top all the pages being worked on. Actual content should be on the working page or in a bug report.
    • Put a comment at the top of the existing page, "UNDER CONSTRUCTION bug #123" with the bug number. This is a safeguard to ensure two people don't start making major edits to the same section and potentially either duplicate or lose work.
    • Put a link to this page in your bug.

[edit] Have things reviewed

  • Change the status of the bug to resolved with resolution fixed. This will trigger review.
  • Wait a while. If there is violent objection someone will reopen the bug. Discussion can happen on the bug thread or UI Best Practices Working Group mailing list. Issues can also be brought up at one of the meetings.

[edit] Merge your changes into the drafts

  • If after one week nobody has raised any objections to the changes, move your content from the sandbox to the draft pages here: UI Best Practices v3.x