How to report a bug: Difference between revisions
m (→Reporting a Bug on GitHub: minor changes) |
(Drop i18n template) |
||
| (13 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
Thank you for helping us make Diaspora better. :)<br /> | |||
If you want to start contributing [[How to work on bugs|by fixing a bug, here is how to]]. If you found a bug and want to report it, this is the correct page. | |||
If you’ve found an issue with an '''existing feature''' in Diaspora, you can either | If you’ve found an issue with an '''existing feature''' in Diaspora, you can either | ||
# report it using [https://github.com/diaspora/diaspora/issues Github issues], | # report it using [https://github.com/diaspora/diaspora/issues Github issues], | ||
# report it in a public post on Diaspora with the #bug | # report it in a public post on Diaspora with the #bug hashtag. | ||
=== Reporting security issues === | |||
If you want to inform us about any security exploits in Diaspora, please contact us privately by sending an email to [mailto:security@diasporafoundation.org security@diasporafoundation.org], corresponding public key [http://pgp.mit.edu/pks/lookup?op=vindex&search=0x6F70243F27AD886A (keyID: 27AD886A)]. | |||
=== Reporting a Bug on GitHub === | === Reporting a Bug on GitHub === | ||
# '''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 | # '''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 | # '''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 21: | ||
#* 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 | # '''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). | ||
= Feature suggestions = | = Feature suggestions = | ||
Please | {{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 | If you have a feature idea, the best place to suggest it is [[How We Communicate#Discourse|diaspora* Discourse]]. You can also make a public post on Diaspora with the #feature hashtag. | ||
In case you want to discuss your idea first, before | In case you want to discuss your idea first, before "officially" posting it anywhere, you can always join us on [[How_We_Communicate#IRC|IRC]]. | ||
[[Category:Community]] | [[Category:Community]] | ||
[[Category: | [[Category:Developers]] | ||
[[Category:Github transfer done]] | |||
Latest revision as of 02:44, 15 October 2018
Thank you for helping us make Diaspora better. :)
If you want to start contributing by fixing a bug, here is how to. If you found a bug and want to report it, this is the correct page.
If you’ve found an issue with an existing feature in Diaspora, you can either
- report it using Github issues,
- report it in a public post on Diaspora with the #bug hashtag.
Reporting security issues
If you want to inform us about any security exploits in Diaspora, please contact us privately by sending an email to security@diasporafoundation.org, corresponding public key (keyID: 27AD886A).
Reporting a Bug on GitHub
- Register for an account on Github, if you don’t already have one.
- 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. - 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.
- 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 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).
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 diaspora* Discourse. 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.