[webkit-reviews] review denied: [Bug 35223] Add a page on how to ask questions : [Attachment 49178] First try: Add such a page and tweak contact.html

bugzilla-daemon at webkit.org bugzilla-daemon at webkit.org
Thu Mar 11 17:32:08 PST 2010


David Levin <levin at chromium.org> has denied Julien Chaffraix
<jchaffraix at webkit.org>'s request for review:
Bug 35223: Add a page on how to ask questions
https://bugs.webkit.org/show_bug.cgi?id=35223

Attachment 49178: First try: Add such a page and tweak contact.html
https://bugs.webkit.org/attachment.cgi?id=49178&action=review

------- Additional Comments from David Levin <levin at chromium.org>
Darin's comments plus these.


> diff --git a/WebKitSite/asking_questions.html
b/WebKitSite/asking_questions.html
> +<h2> Be precise </h2>
> +Give us as many details as possible. Generic questions will get generic
answers.

Explain as many details as possible. Generic questions will likely not get a
valuable response.


> +Also people are less likely to answer generic questions as they are not sure
what the question really is.
> +
> +Make sure you include at least:</br>
> +<li> which port are you using: Apple, Windows, Chromium, Qt, Gtk, Wx,
...</li>

I think OSX or Mac is typically used instead of Apple.


> +Remember that we are not in your head so the most you give us, the easier it
will be for us to help you.

Since we cannot read your mind, the more you give us, the easier it will be for
us to help you.

> +(You can find the complete output here: http://foobar.com).<br><br>

This doesn't use pastebin.com as you suggested above.

> +
> +There are some questions that appears regularly on the mailing list. We have
included the answers here for more convenience.

s/appears/appear/
s/more convenience/your convenience/

> +
> +<h3> Does WebKit supports Foo? </h3>
> +
> +The most reliable way to answer it is by looking at the source code. WebKit
development is fast
> +pace, often the asked feature is already implemented although it has
paced. Often the requested feature is already implemented although it has


> +not been widely used yet. Bear in mind, sometimes the level of
> +supports between different ports are not the same (example: Apple port
s/are/is/

I don't think this example adds much with X as the feature.

> +has implemented feature X, but Qt port still does not have it).

> +The following links are also useful (note that they may be incorrect
> +or outdated):<br>

Do you need to tell people that it is incorrect or outdated?

> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(HTML)">Wikiped
ia comparison of the layout engines: HTML support</a><br></li>
> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(XML)">Wikpedia
comparison of the layout engines: XML support</a><br></li>
> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Cascading_Styl
e_Sheets)">Wikipedia comparison of the layout engines: CSS support</a><br></li>

> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Document_Objec
t_Model)">Wikipedia comparision of the layout engines: DOM support</a><br></li>

> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(HTML_5)">Wikip
edia comparision of the layout engines: HTML5 support</a><br></li>
> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(ECMAScript)">W
ikipedia comparison of the layout engines: ECMAScript support</a><br></li>
> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Scalable_Vecto
r_Graphics)">Wikipedia comparison of the layout engines: SVG support<br></li>
> +<li><a
href="http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Non-standard_H
TML)">Wikipedia comparison of the layout engines: non standard HTML
support</a><br></li>
> +
> +<h3> I want to port WebKit to a new platform? </h3>

This isn't a question.

> +
> +As a starting point, check first <a
href="http://trac.webkit.org/wiki/SuccessfulPortHowTo">the sucessful port
how-page</a>.
s/how-page/how to page/

> +
> +Granted, it's not complete, feel free to contribute. Also, try to find a
port similar to what you are targeting and use it
Try to find a port similar to what you are targeting and use it
> +as a basis, instead of writing everything from scratch.

as a basis, instead of writing everything from scratch. While doing your port,
you may find that you wished the page had 
mentioned that fact.Please modify the page and add it.

> +
> +<h3> What the code flow is? </h3>
How does X work?

> +
> +The best answer is to fire your debugger. WebKit code move really fast - as
we already said - and giving such an answer at one

The best way to answer this is to use your debugger. Set a break point where
you want to investigate and get a stack trace. Then, you will
see which functions call your code.

> +
> +<h2> Things to remember when you ask a question </h2>
> +
> +<li> We offer our help on a voluntary basis, you can't expect us to be
s/you/but you/

> +100% at your disposal. Be patient, no need to insist on the urgency
s/Be patient, no/ Be patient. No/


> +<li> WebKit is a big project with a huge code base, you must be willing
s/, you/, so you/



> +<li>Last but least: there are often (negative) complaints that WebKit code
s/least:/least,/
s/(negative)//

> +is not easy to understand. Well, this is your chance to contribute! We
> +have started some helping pages on this, just check out:
> +<a
href="http://trac.webkit.org/wiki/WikiStart#GettingAroundtheWebKitSourceCode">o
ur wiki's page to get around the code</a></li>

s/get/getting/
s/around/around in/


> diff --git a/WebKitSite/contact.html b/WebKitSite/contact.html
> +<p><a
href="http://lists.webkit.org/mailman/listinfo/webkit-dev">webkit-dev</a> is
for discussion of the WebKit project's development per itself. If you do not
intent to hack WebKit, you should direct your questions to webkit-help.</p>

s/hack/contribute patches to//


More information about the webkit-reviews mailing list