Mini-guide for Bug reporting: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
 
Line 3: Line 3:


==Reporting a Bug or requesting a Feature==
==Reporting a Bug or requesting a Feature==
* Click on ‘Login anonymously’ to log in to the Tracker.
* Check if you can find an existing issue, that matches the problem you have.
** Alternatively, if you want to you can directly create an account at our tracker and then file bugs or features by yourself. To do so, choose ‘Sign up for a new account’ at the login page instead of ‘Login anonymously’. We don’t mind that at all.
* Once logged in click on the ‘View Issues’ link.
* After that page has loaded set ‘Hide Status’ to ‘resolved (And Above)’ to filter out issues that have been dealt with already.
* Search by (parts of) the title of the screen, the name of a field on the screen or by some key words that are used on that screen to see if you can find issues relating to the screen that you want to record an issue for. Enter those terms in the text box under ‘Search’ and click ‘Apply Filter’.
* Search by (parts of) the title of the screen, the name of a field on the screen or by some key words that are used on that screen to see if you can find issues relating to the screen that you want to record an issue for. Enter those terms in the text box under ‘Search’ and click ‘Apply Filter’.
* If the filtering operation returned no issues, or not the one that you found, you can just go ahead and report them: use the ‘Report Issue’ link for that if you are logged in as a user or send an email to: [[mailto:info@openpetra.org info@openpetra.org]].
* If the filtering operation returned no issues, or not the one that you found, you can just go ahead and report them.
** In either case please specify at least:
** Please specify at least:
*** the Module (i.e. Partner Module, Finance Module,...) that the screen is found in [these Modules are sub-projects in Mantis: your choice of Module limits the topics for the category for that bug and that will help us in classifying and assigning bugs and features];
*** the Module (i.e. Partner Module, Finance Module,...) that the screen is found in
*** the title of the screen (put it in ‘Summary’ together with some short description of the problem);  
*** the title of the screen (put it in ‘Summary’ together with some short description of the problem);  
*** describe the problem as best as you can (in ‘Description’ in Mantis), mentioning any error message;
*** describe the problem as best as you can, mentioning any error message;
*** if the problem is reproducible it would be a great help if you could provide the steps that lead to the problem every time.
*** if the problem is reproducible it would be a great help if you could provide the steps that lead to the problem every time.

Latest revision as of 19:29, 4 November 2020

Preface

Before you record something you think is not working, or does not seem what you think it ought to do, or if the application issues an error dialog, please have a look in our bug and feature tracking facility first (found at Github)!

Reporting a Bug or requesting a Feature

  • Check if you can find an existing issue, that matches the problem you have.
  • Search by (parts of) the title of the screen, the name of a field on the screen or by some key words that are used on that screen to see if you can find issues relating to the screen that you want to record an issue for. Enter those terms in the text box under ‘Search’ and click ‘Apply Filter’.
  • If the filtering operation returned no issues, or not the one that you found, you can just go ahead and report them.
    • Please specify at least:
      • the Module (i.e. Partner Module, Finance Module,...) that the screen is found in
      • the title of the screen (put it in ‘Summary’ together with some short description of the problem);
      • describe the problem as best as you can, mentioning any error message;
      • if the problem is reproducible it would be a great help if you could provide the steps that lead to the problem every time.