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

Some useful resources to read/watch before

The steps to follow for creating an issue are as follows:

  1. Login to github
  2. Click on “issues” in the header menu
  3. Verify that your issue has not been already created
  4. If the issue is new, then create a new one by clicking on “New Issue” button
  5. Fill in the following details:
  • Title: Give a short and descriptive title
  • Give as much details are you can in the comment section:
    • Provide a URL (link) of the site where the error is appearing
    • 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.
    • Example: On the Natural Protected Area profile page, using Textual search to find “Ponhea Kraek Multiple Use Area”, then scroll to right to see the reference file. When click on the link of reference doc, it didn’t work, it brought me to 404 page.
    • Provide one or more screenshots showing the problem.
    • Specify the environment in which the issue appears (operating system, browser version). Example: The problem appears on windows using firefox version 48.0 but does not appear on OSX using safari.
    • Specify what is the expected behaviour and how the current status does not reflect it.
    • Labels: provide as many relevant labels as possible to your issue. Please refer to the list of labels below.
    • Assignees: Each issue should be assigned to a person to make sure that it gets looked after. If you know the person that is responsible for the issue then assign her, otherwise, assign the issue to @derwas and @declan-derilinx

Labels

Labels (Alphabetic order): A list of github labels is available in https://github.com/OpenDevelopmentMekong/IssuesManagement/labels Descriptions are available to help identify the meaning of each label:

  • Access: If you need to grant access rights to a user for particular service, e.g., Can you make user xyz a sysadmin on ODMy.
  • Bug: Something isn't working, e.g., Search in ODC is not working.
  • CKAN: CKAN issue, e.g., A private dataset appear in public search results.
  • Duplicate: This issue or pull request already exists, e.g., two different users reported on the same problem in two different github issues.
  • Enhancement: New feature or request, e.g., Enabling draft dataset co-editing.
  • Geoserver: Geoserver issue, e.g., Unable to upload data to Geoserver.
  • Help Wanted: Extra attention is needed, e.g., Translations are not complete for certain forms.
  • Invalid: This doesn't seem right e.g., Search results are working fine but the results do not look right!
  • ODC: The issue relates to ODCambodia
  • ODL: The issue relates to ODLaos
  • ODM: The issue relates to ODMekong
  • ODMy: The issue relates to ODMyanmar
  • ODT: The issue relates to ODThailand
  • ODV: The issue relates to ODVietnam
  • Question: Further information is requested, e.g.,
  • Solr: Solr issue, e.g., Search index is not accessible
  • Urgent: ONLY for urgent issues that need immediate attention!
  • Wontfix: This will not be worked on; this label is assigned by the tech team when they think that an issue cannot be fixed.
  • Wordpress: Wordpress issue, e.g., I am not able to login to Wordpress.

Requesting the implementation of a new feature or enhancement

A feature request proposes the implementation of a new functionality or the improvement of an existing one. Please outline the following:

  • Adequately describe the specifications of the features functions, i.e. how should the feature work and what should a user expect from the new feature.
  • Add design mock-ups on how you would like the feature to look if you are able.
  • Specify links on the pages/modules where the new feature should be implemented on the front end.
public/bug_reporting.txt · Last modified: 2019/11/18 14:36 (external edit)