Page MenuHomePhabricator

Write a Wikimedia blog post "How to create a good first bug report" covering Phabricator
Closed, ResolvedPublic

Description

@Elitre says (and @Whatamidoing-WMF seconded that):

https://blog.wikimedia.org/2013/03/18/how-to-create-a-good-first-bug-report/ it'd be useful to have a Phab version and/or someone reviewing https://www.mediawiki.org/wiki/How_to_report_a_bug.

Anybody is very welcome to draft a blogpost and I'm happy to help by providing feedback and co-editing.

Event Timeline

Aklapper raised the priority of this task from to Lowest.
Aklapper updated the task description. (Show Details)

@Qgil seen you've put this in Proposed for Oct/Dec over on Engineering-Community, alright to give it a go now?

@Aklapper I've created a working draft here: https://meta.wikimedia.org/wiki/Wikimedia_Blog/Drafts/A_good_first_Bug_Report - is this going in the right direction? Needs expanding in some sections/headers and making a bit more friendly.

Qgil raised the priority of this task from Lowest to Low.
Qgil set Security to None.

Thank you @Samtar for stepping in! We'll help you with the article, of course.

Hi @Samtar, thanks a lot for working on this! Very appreciated, and that looks good so far!

Some comments:

  • "A good first Bug Report" - add "or feature request"? I would not mention "Phabricator" in the title as that is already an implementation detail, and it's rather about what people would like to achieve (help making the MediaWiki software and the Wikimedia sites better).
  • I'd also replace "bug tracker" by "software issue tracker" or such - as it's not only for bugs.
  • "but bugs are as inevitable as death and taxes. Although in the past The Wikimedia Foundation used Bugzilla, we've now moved on to Phabricator as the system for users to report bugs they encounter while using MediaWiki and Wikimedia sites." - I'd shorten that to "but mistakes are inevitable. Wikimedia uses a system called Phabricator to organize software development and manage software bugs and feature requests." If we want to explain how to create a good bug report, people might not be interested in history or terms like "Bugzilla" they might have never heard of.
  • "spend some time working out the steps taken to make it happen - and test these to ensure it wasn't just a one off issue. After you've confirmed the problem still exists" - While you are of course right, I'm afraid that some readers might think "OK, this will take too much time" and not report. Could we phrase this in a way that it's "very welcome" to test whether the problem can be reproduced and wasn't just intermittent?
  • "You'll need to navigate to Maniphest, and then choose Create Task in the top right corner." - There's no need to navigate to Maniphest first, but I'd mention that there is a "Plus" button in the top right corner to create a so-called "task" (which can be a bug report or a feature request).
  • "You may be prompted to log in" - Before covering how to create a task, I'd explain first that creating a report (or "task") requires a Phabricator account and that you can easily re-use your existing Wikimedia account by clicking the button in the upper right corner and then clicking on the sunflower. I'd add a link to the corresponding documentation at https://www.mediawiki.org/wiki/Phabricator/Help#Creating_your_account_and_notifications too. You can try yourself: Go to https://phabricator.wikimedia.org/ without being logged in and see that there is no way to create a task yet. :)
  • "You'll then be presented with the bug submission form." - You are technically right here but "form" sounds scary. :) What about "You'll be asked to provide some information."
  • "Normally you'll be able to choose MediaWiki-General-or-Unknown if you've found the issue on Wikipedia." - "You can just enter MediaWiki-General-or-Unknown in the 'Projects' field if you are unsure. Someone who takes a look at your report later might change the project to a more specific one so it becomes easier for the corresponding developers of that area to find your report."
  • "My browser stopped responding and crashed" - can I sneak in something like "Firefox version 40"? Browser info is always welcome. :)
  • "the bug's description, click Create Task." - actually now it's a bug report, not just a bug. :) I'd also mention that Create Task is the button at the bottom (as there is also that link with the same name at the top that we used earlier).
  • "The bug report has now been created and you've successfully helped keep Wikipedia running smoothly." What about: "Your bug report has now been created and everybody can take a look at it. Thank you for helping make Wikimedia websites and MediaWiki become better!"
  • "Wikipedia" - it's more than that! We also welcome reports about Commons, Wiktionary, etc. :)
  • I'd also link to https://www.mediawiki.org/wiki/How_to_report_a_bug for more information, and also to https://www.mediawiki.org/wiki/Phabricator/Help where we try to cover everything that might help people to get started with Phabricator (imagine you have never used that "Phabricator" thingy before - it can be quite confusing). And we also welcome any questions on the discussion page of the Help page so I'd love to communicate that questions are welcome!

Again, this is a great start! Thank you so much for giving this a shot!

@Aklapper thanks for those suggestions, I'll get those added in :)

@Aklapper - can I ask why you removed @EdErhart-WMF's Wikimedia-Blog project tag? This seems directly related and would be good to keep track of.

can I ask why you removed @EdErhart-WMF's Wikimedia-Blog project tag?

Hi, see the project description - it's about the technical platform only.

Made some more edits on https://meta.wikimedia.org/wiki/Wikimedia_Blog/Drafts/A_good_first_Bug_Report

I think we're ready to go here? Again thanks for working on this, @Samtar!

@Aklapper that's very weird - I just emailed a blog team member about an hour ago to get it reviewed!

What is the situation of this blog post?

@jrbs: Thank you so much for this. I'm very happy to see that article published!
Only thing I wonder: Are the two images of Editatona.webm.jpg in that article on purpose? :)

In any case, again thank you a lot.
I've linked to the blogpost from https://www.mediawiki.org/wiki/How_to_report_a_bug

Feel free to change this task's status to resolved in the "Action" dropdown.

@jrbs: Thank you so much for this. I'm very happy to see that article published!
Only thing I wonder: Are the two images of Editatona.webm.jpg in that article on purpose? :)

A very good question. I've taken them out because I'm not really sure what they're doing in there!

Feel free to change this task's status to resolved in the "Action" dropdown.

Done :)