Skip to content

Bug Report writing Guidelines

Jump to bottom
tfr42 edited this page May 25, 2017 · 21 revisions

Bug Report writing Guidelines

Effective bug reports are the most likely to be fixed. These guidelines explain how to write such reports. You can submit all kinds of issues. In case the service configuration does not work or there are strange rendering artefacts or protocol problems, the issue tracker is the right tool to use.

Before reporting a bug please make every effort to resolve the problem yourself. Then check the [Open Bugs Report] (https://github.com/deegree/deegree3/issues?q=is%3Aissue+is%3Aopen+label%3Abug) if a similar issue has been reported already.

If you need help, ask on the [users mailing list] (https://lists.sourceforge.net/lists/listinfo/deegree-users) and read the article [requesting community support] (http://deegree.org/community/guidelines) first. The issue tracker is a tool to track bug reports and feature requests and is not a support forum! In case of questions on how to configure your own system, or how to interpret some error message or behaviour that you do not understand, please ask on the [users mailing list] (https://lists.sourceforge.net/lists/listinfo/deegree-users). A good place to get support is also at [gis.stackexchange.com] (https://gis.stackexchange.com/questions/tagged/deegree). Use the tag "deegree" to link it to our project.

Principles

  • Be precise
  • Be clear - explain it so others can reproduce the bug
  • One bug per report
  • No bug is too trivial to report - small bugs may hide big bugs
  • Clearly separate fact from speculation

Reporting a New Bug

  • Summary: Enter a clear and meaningful summary
  • Description field shall include:
    • Steps to Reproduce
    • Actual and expected behaviour
    • Additional information on version, platforms, database, Java EE servlet container, JVM vendor, ...
    • Version: provide the version of deegree
  • Milestone: leave this field empty. The milestone will be set by the TMC members.

Reporting a security vulnerability

If you encounter a security vulnerability in deegree please take care to report the issue in a responsible fashion:

  • Keep exploit details out of the issue report (send to TMC privately – just like you would do for sensitive sample data) Mark the issue as a vulnerability!
  • Be prepared to work with Technical Management Committee (TMC) members on a solution!
  • Keep in mind TMC members are volunteers and an extensive fix may require fundraising and other kinds of contributions!

Ticket lifecycle

  • After submitting a bug report the ticket will have state waiting for triage. In this state the TMC or the reporter will search for volunteers to fix this bug.
  • As soon as a developer has accepted to solve the bug the ticket will change to state in progress.
  • After the funding is clarified and a developer is available the the assignee will change to the assigned developer.
  • The assigned developer implements the bug fix and sets a fix version. When the work is finished and the pull request is accepted by the TMC the issue and the related pull request will change to CLOSED.
Clone this wiki locally