Difference between revisions of "How to report a bug"

From diaspora* project wiki
Jump to: navigation, search
(Add language selector)
(Reporting a Bug on GitHub: changed 'bug' to 'issue' where referring to Github issues.)
Line 10: Line 10:
  
 
# '''Register for an account on [https://github.com Github],''' if you don’t already have one.
 
# '''Register for an account on [https://github.com Github],''' if you don’t already have one.
# '''Search for similar bugs.''' Perhaps someone has already reported your issue! <br>If so, please add any new information or clarification to the '''existing''' bug, if you can.
+
# '''Search for similar issues.''' Perhaps someone has already reported your bug! <br>If so, please add any new information or clarification to the '''existing''' issue, if you can.
# '''Create a new bug.''' If you don’t find any similar issues, you can report your bug via the “new issue” tab once you’ve logged in. Please, always include the pod you experienced the bug on and, if necessary, a link to the post that shows the symptoms or a screenshot showing what happened. Don’t be shy and specify as many details as possible -
+
# '''Create a new issue.''' If you don’t find any similar issues, you can report your bug via the “new issue” tab once you’ve logged in. Please, always include the pod you experienced the bug on and, if necessary, a link to the post that shows the symptoms or a screenshot showing what happened. Don’t be shy and specify as many details as possible -
 
#* what error message did you see,
 
#* what error message did you see,
 
#* did you publish a post publicly/to aspects,
 
#* did you publish a post publicly/to aspects,
Line 17: Line 17:
 
#* what pod is(are) the other user(s) on.
 
#* what pod is(are) the other user(s) on.
 
# '''Monitor your issue and respond to questions.''' It may be necessary to provide additional information upon request or you might be asked if the bug still occurs after a new release.
 
# '''Monitor your issue and respond to questions.''' It may be necessary to provide additional information upon request or you might be asked if the bug still occurs after a new release.
# '''Close your bug.''' In case you notice that the bug doesn’t occur anymore, you can close the issue yourself (don’t forget to add a note saying the issue is resolved).<br>If you find out your bug is actually a duplicate of another bug and only notice that after you created it, please also close your bug with a short reference to the other issue that was there before.
+
# '''Close your issue.''' In case you notice that the bug no longer occurs, you can close the issue yourself (don’t forget to add a note saying the issue is resolved).<br>If you find out your bug is actually a duplicate of another bug and only notice that after you created it, please also close the issue you opened with a short reference to the existing issue (tip: if you use a # symbol followed by the number of the other issue, it will create a hyperlink to that issue).
  
 
=== Reporting security issues ===
 
=== Reporting security issues ===

Revision as of 16:55, 29 December 2013

Template:Languages

Thank you for helping us make Diaspora better. :)
If you’ve found an issue with an existing feature in Diaspora, you can either

  1. report it using Github issues,
  2. report it in a public post on Diaspora with the #bug hashtag.

Reporting a Bug on GitHub

  1. Register for an account on Github, if you don’t already have one.
  2. Search for similar issues. Perhaps someone has already reported your bug!
    If so, please add any new information or clarification to the existing issue, if you can.
  3. Create a new issue. If you don’t find any similar issues, you can report your bug via the “new issue” tab once you’ve logged in. Please, always include the pod you experienced the bug on and, if necessary, a link to the post that shows the symptoms or a screenshot showing what happened. Don’t be shy and specify as many details as possible -
    • what error message did you see,
    • did you publish a post publicly/to aspects,
    • were images attached to a post,
    • what pod is(are) the other user(s) on.
  4. Monitor your issue and respond to questions. It may be necessary to provide additional information upon request or you might be asked if the bug still occurs after a new release.
  5. Close your issue. In case you notice that the bug no longer occurs, you can close the issue yourself (don’t forget to add a note saying the issue is resolved).
    If you find out your bug is actually a duplicate of another bug and only notice that after you created it, please also close the issue you opened with a short reference to the existing issue (tip: if you use a # symbol followed by the number of the other issue, it will create a hyperlink to that issue).

Reporting security issues

If you wish to contact us privately about any security exploits in Diaspora you may find, you can email exploits@joindiaspora.com, corresponding public key (keyID: 77485064).

Feature suggestions

»» Note
Please don't use Github issues simply for suggesting a new feature.


If you have a feature idea, the best place to suggest it is the mailing lists or the Loomio platform. You can also make a public post on Diaspora with the #feature hashtag.

In case you want to discuss your idea first, before "officially" posting it anywhere, you can always join us on IRC.