Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

blog post: "Five (?) simple rules for writing awesome bug reports (you won't believe #3)" #81

Open
orbeckst opened this issue Jul 3, 2018 · 6 comments
Labels
Blog blog content and articles

Comments

@orbeckst
Copy link
Member

orbeckst commented Jul 3, 2018

Following up on the discussion in PR MDAnalysis/mdanalysis#1967 we might want to write our own short post on what we would people like to consider when submitting bug reports for MDAnalysis.

  • issue tracker is for bugs, enhancements, API decisions
  • mailing lists are for general "How do I...?" and "What is ...?" questions

The issue template already does a good job focusing on the key things.

If any of the @MDAnalysis/coredevs has opinions on the matter, please discuss them in this issue.

@orbeckst
Copy link
Member Author

orbeckst commented Jul 3, 2018

(Originally MDAnalysis/mdanalysis#1967 (comment)) I quite like Simon Tatham's https://www.chiark.greenend.org.uk/~sgtatham/bugs.html (and the related http://www.catb.org/esr/faqs/smart-questions.html by ESR). https://musescore.org/en/handbook/developers-handbook/getting-started/how-write-good-bug-report-step-step-instructions is also good.

Maybe we can distill all of the above into a short read. Short seems important to me because for most people, raising an issue already means overcoming a high activation barrier – especially for the kind of knowledgeable users that might be able to give very good issue reports. Keeping any additional (even optional) reading short is good.

Perhaps we manage to boil it down to five bullet points, along the "Ten simple rules for ....".

@orbeckst orbeckst changed the title blog post of our own "How to write awesome bug reports" blog post of our own "Five (?) simple rules for writing awesom bug reports" Jul 3, 2018
@orbeckst orbeckst changed the title blog post of our own "Five (?) simple rules for writing awesom bug reports" blog post of our own "Five (?) simple rules for writing awesome bug reports" Jul 3, 2018
@orbeckst orbeckst changed the title blog post of our own "Five (?) simple rules for writing awesome bug reports" blog post: "Five (?) simple rules for writing awesome bug reports" Jul 3, 2018
@richardjgowers
Copy link
Member

So we're buzzfeed now? :)

@richardjgowers richardjgowers changed the title blog post: "Five (?) simple rules for writing awesome bug reports" blog post: "Five (?) simple rules for writing awesome bug reports (you won't believe #3)" Jul 4, 2018
@kain88-de
Copy link
Member

kain88-de commented Jul 4, 2018 via email

@orbeckst
Copy link
Member Author

orbeckst commented Jul 4, 2018

I was more inspired by PLOS than BuzzFeed ;-). But I had to laugh at the new issue title. 🤣

(Thanks for the link for "10 Rules to write a 10 Rules article" – I hadn't seen that one.)

@orbeckst orbeckst added the Blog blog content and articles label Jul 17, 2018
@orbeckst
Copy link
Member Author

See also "community page" #62

@orbeckst
Copy link
Member Author

See also Alan Grossfield's How to be a good member of a scientific software community https://osf.io/kgr45/

(Somewhat related https://exercism.org/docs/community/being-a-good-community-member because I stumbled over it and liked it.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blog blog content and articles
Projects
None yet
Development

No branches or pull requests

3 participants