[wp-meta] [Making WordPress.org] #607: Add information about error reporting in the code reference
Making WordPress.org
noreply at wordpress.org
Fri Sep 12 19:24:04 UTC 2014
#607: Add information about error reporting in the code reference
---------------------+-------------------------------------
Reporter: wedi | Owner:
Type: defect | Status: new
Priority: normal | Component: developer.wordpress.org
Resolution: | Keywords:
---------------------+-------------------------------------
Comment (by wedi):
The explanation you just gave is short and great to understand! Maybe one
could add a small info box somewhere? Maybe on the starting page or even
better a call to action next to the simple "View on Trac" link?
Example:
''This code reference is automatically built from the inline documentation
in the core code itself.
[https://core.trac.wordpress.org/browser/tags/4.0/src/wp-
admin/includes/plugin.php#L575 View the corresponding source code on Trac]
Any errors you find are errors in WordPress itself. Please
[http://make.wordpress.org/core/handbook/reporting-bugs/ report any
issues] to the [https://core.trac.wordpress.org/ core bug tracker].''
It would be amazing if the a link would point to a guide like "Step-by-
step: How to report and patch issues in the WordPress Code Reference".
The experienced core dev has no problem fixing such an issue in a minute
but the ordinary plugin author is initially scared. That's why I suggest
to take him by the hand and guide him through the first steps, just like
@georgestephanis kindly offered in my initial issue #606 but on a more
general level of course. I think that's a great opportunity to get more
devs involved (if that's needed). The hurdle for a documentation patch is
much lower than for a code one where other issues like 'Can I keep up with
these experienced core devs?' come into play. And once the first patch has
landed people will probably see (I'll tell you afterwards) there's no
magic formula involved.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/607#comment:2>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list