User Tools

Site Tools


public:bug_reporting

Reporting bugs and/or feature requests on github

Who is this guide for

  • External users testing the platform
  • Internal staff helping improve the code base

What this guide teaches

  • How to report bugs or problems currently being reproduced on the platform
  • How to request implementation of new features and enhancements

Things to know in forehand

Issues should be filed on the corresponding github repository

The code base of the ODM project is composed by several different code repositories found on https://github.com/OpenDevelopmentMekong/. Depending on what part of the system the bug report of feature request relates to, Issues should be raised in the corresponding github repostory.

As a rule of thumb, issues relating to the frontend will be reported on https://github.com/OpenDevelopmentMekong/wp-odm_theme/ or https://github.com/OpenDevelopmentMekong/wpckan depending on whether it , CKAN issues on https://github.com/OpenDevelopmentMekong/ckanext-odm_dataset, https://github.com/OpenDevelopmentMekong/ckanext-odm_library or https://github.com/OpenDevelopmentMekong/ckanext-laws depending on the type of dataset.

Some useful resources to read/watch before

Make sure that the Issue/Feature that you are raising has not been reported yet

In order to avoid creating duplicated Issues, the reporter should first check if it has not been reported yet. For that, it is very helpful to use the search function of the Github Issues.

Example search for “data page”…

Reproducing and describing bugs

Keeping a consistent methodology for reproducing bugs is very important. Once a tester identifies an error, the conditions for repeating it need to be gathered in order for developers to reproduce the scenario and be able to test solutions. This process consist on following steps:

  1. Provide a descriptive title
  2. Provide a URL (link) of the site where the error is appearing
  3. Provide a list of actions that need to be done to make the error appear. Example: Scroll down to bottom of site and click on the download link.
  4. Provide one or more screenshots showing the problem.
  5. Specify the environment in which the issue appears (operative system, browser version). Example: The problem appears on windows using firefox version 48.0 but does not appear on OSX using safari.
  6. Specify what is the expected behaviour and how the current status does not reflect it.

Requesting the implementation of a new feature or enhancement

Instead of informing of an error on the functionality, a feature request proposes the implementation of a new functionality or the improvement of an existing one.

While creating a github Issue with a feature requests please:

- Add design mockups on how you would like the feature to look like - Provide detailed description on how the new feature should work and how the user is supposed to use it. - Specify links on the pages/modules where the new feature should be implemented.

Creating an issue on github containing the bug's or feature request details

Once the information specified above has been gathered, open the corresponding github repository. Example: https://github.com/OpenDevelopmentMekong/wp-odm_theme and click on Issues » New Issue, set a descriptive title and add the steps for reproducing the error, the screenshot and further information in the description.

public/bug_reporting.txt · Last modified: 2016/10/13 17:19 by acorbi