A user account is required in order to edit this wiki, but we've had to disable public user registrations due to spam.

To request an account, ask an autoconfirmed user on Chat (such as one of these permanent autoconfirmed members).

Difference between revisions of "Reviewing"

From WHATWG Wiki
Jump to navigation Jump to search
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Are you interested in reviewing HTML5 for errors?
Are you interested in reviewing the HTML standard for errors?


Jump in! All feedback is welcome, from anyone.
Jump in! All feedback is welcome, from anyone.


# Open the specification: either the [http://www.whatwg.org/specs/web-apps/current-work/ one-page version], or the [http://whatwg.org/html5 multipage version] or the PDF copy ([http://www.whatwg.org/specs/web-apps/current-work/html5-a4.pdf A4], [http://www.whatwg.org/specs/web-apps/current-work/html5-letter.pdf Letter])
# Open the specification: either the [http://www.whatwg.org/specs/web-apps/current-work/ one-page version], or the [http://whatwg.org/html multi-page version] or the PDF copy ([http://www.whatwg.org/specs/web-apps/current-work/html5-a4.pdf A4], [http://www.whatwg.org/specs/web-apps/current-work/html5-letter.pdf Letter])
# Start reading! See below for ideas of what to look for.
# Start reading! See below for ideas of what to look for.
# If you find a problem, either send an e-mail to [http://www.whatwg.org/mailing-list#specs the WHATWG list] ([email protected], subscription required), [http://www.w3.org/Bugs/Public/enter_bug.cgi?assigned_to=dave.null%40w3.org&blocked=&bug_file_loc=&bug_severity=normal&bug_status=NEW&comment=&component=Spec%20bugs&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&dependson=&description=&form_name=enter_bug&keywords=externalComments&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=P3&product=HTML%20WG&qa_contact=public-html-bugzilla%40w3.org&rep_platform=All&short_desc=&target_milestone=---&version=unspecified file a bug] (registration required), send an e-mail to the [email protected] list (no subscription required), or send an e-mail directly to [email protected]
# If you find a problem, either send an e-mail to [http://www.whatwg.org/mailing-list#specs the WHATWG list] ([email protected], subscription required), file a bug via the specification, file a bug [http://www.w3.org/Bugs/Public/enter_bug.cgi?assigned_to=dave.null%40w3.org&blocked=&bug_file_loc=&bug_severity=normal&bug_status=NEW&comment=&component=Spec%20bugs&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&dependson=&description=&form_name=enter_bug&keywords=externalComments&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=P3&product=HTML%20WG&qa_contact=public-html-bugzilla%40w3.org&rep_platform=All&short_desc=&target_milestone=---&version=unspecified directly in Bugzilla] (registration required), send an e-mail to the [email protected] list (no subscription required), or send an e-mail directly to [email protected]


If everything goes according to plan, all issues will get a response from the editor before October. You can track how many issues remain to be responded to [http://www.whatwg.org/issues/data.html on our graph].
You can track how many issues remain to be responded to [http://www.whatwg.org/issues/data.html on our graph].


== What to look for ==
== What to look for ==
Line 17: Line 17:
You don't really need any experience to find the simplest class of problems: things that are confusing! If you don't understand something, then that's a problem. Not all the introduction sections and examples are yet written, but if there is a section with an introduction section that isn't clear, then you've found an issue: let us know!
You don't really need any experience to find the simplest class of problems: things that are confusing! If you don't understand something, then that's a problem. Not all the introduction sections and examples are yet written, but if there is a section with an introduction section that isn't clear, then you've found an issue: let us know!


Something else that would now be good to search for is typos, spelling errors, grammar errors, and the like. Don't hesitate to send e-mails even for minor typos, all feedback even on such small issues is very welcome.
Something else that would now be good to search for is typos, spelling errors, grammar errors, and the like. Don't hesitate to send e-mails even for minor typos; all feedback even on such small issues is very welcome.


If you have a specific need as a Web designer, then try to see if the need is met. If it isn't, and you haven't discussed this need before, then send an e-mail to the list. (So for example, if you want HTML to support date picker widgets, you'd look in the spec to see if it was covered. As it turns out, that one is!)
If you have a specific need as a Web designer, then try to see if the need is met. If it isn't, and you haven't discussed this need before, then send an e-mail to the list. (So for example, if you want HTML to support date picker widgets, you'd look in the spec to see if it was covered. As it turns out, that one is!)
Line 25: Line 25:
== Staying in touch ==
== Staying in touch ==


You are encouraged to join our IRC channel #whatwg on Freenode to stay in touch with what other people are doing, but this is by no means required. You are also encouraged to post in the Discussion section below, or in the blog comments for the [http://blog.whatwg.org/help-us-review-html5 corresponding blog post], to let people know what you are reviewing. You can get news updates by following [http://twitter.com/WHATWG @WHATWG] on Twitter.
You are encouraged to join us on [[IRC]] to stay in touch with what other people are doing, but this is by no means required. You can get news updates by following [http://twitter.com/WHATWG @WHATWG] on [http://twitter.com/ Twitter].


== Discussion ==
[[Category:Specification editing]]
 
Once you've reviewed a section, add a note here to let others know that you've looked at it. That way people can coordinate their efforts and we can make better use of our resources.

Latest revision as of 14:42, 9 July 2013

Are you interested in reviewing the HTML standard for errors?

Jump in! All feedback is welcome, from anyone.

  1. Open the specification: either the one-page version, or the multi-page version or the PDF copy (A4, Letter)
  2. Start reading! See below for ideas of what to look for.
  3. If you find a problem, either send an e-mail to the WHATWG list ([email protected], subscription required), file a bug via the specification, file a bug directly in Bugzilla (registration required), send an e-mail to the [email protected] list (no subscription required), or send an e-mail directly to [email protected]

You can track how many issues remain to be responded to on our graph.

What to look for

The plan is to see whether we can shake down the spec and get rid of all the minor problems that have so far been overlooked. Typos, confusion, cross-reference errors, as well as mistakes in examples, errors in the definitions, and major errors like security bugs or contradictions.

Anyone who helps find problems in the spec — however minor — will get their name in the acknowledgements section.

You don't really need any experience to find the simplest class of problems: things that are confusing! If you don't understand something, then that's a problem. Not all the introduction sections and examples are yet written, but if there is a section with an introduction section that isn't clear, then you've found an issue: let us know!

Something else that would now be good to search for is typos, spelling errors, grammar errors, and the like. Don't hesitate to send e-mails even for minor typos; all feedback even on such small issues is very welcome.

If you have a specific need as a Web designer, then try to see if the need is met. If it isn't, and you haven't discussed this need before, then send an e-mail to the list. (So for example, if you want HTML to support date picker widgets, you'd look in the spec to see if it was covered. As it turns out, that one is!)

If you have some specific expertise that lets you review a particular part of the spec for correctness, then that's another thing to look for. For example if you know about graphics, then reviewing the 2D Canvas API section would be a good use of your resources. If you know about scripting, then looking at the "Web browsers" section would be a good use of your time.

Staying in touch

You are encouraged to join us on IRC to stay in touch with what other people are doing, but this is by no means required. You can get news updates by following @WHATWG on Twitter.