Skip to content

Labeling of user issues

Peter-Paul de Wolf edited this page Nov 18, 2016 · 6 revisions

The UserSupport repository will show all user isues related to the sdcTools organisation. These issues can be categorized by users and developers of the sdcTools team by applying certain predefined labels. These labels can always be changed afterwards, for instance in case a question is answered, a bug is fixed or an issue is closed. These labels are the following, divided in four dimensions:

  • indication of tool: mu-Argus, tau-Argus, sdcMicro, sdcTable
  • type of issue: enhancement, bug feature, question
  • status of issue: duplicate, help-wanted, invalid, wontfix, needs-discussion
  • indication of issue priority: low, medium, high, blocks-production

The text of the issues can be submitted, read and answered by anyone who is a member of Github. That is, no membership op the sdcTools organization or the UserSupport repository is needed.

For many issues, for instance for bug issues, the issue text can preferably be supplied with some screen shots or other graphicals, and small data files, so that the issue is clear and can easily be reproduced by the sdcTools core team. In this sense the GitHub platform is open for anyone. For this reason it is obvious that no sensitive information should be contained in the issue text, graphicals, parameter values and data files.

In case of lack of clarity of the issue text, or lack of clarity of the issue solution, the text can be edited instead of repeatingly adding new text. That way the resulting questions and answers texts should be concise and easily readable for any users that might have the same issues.

Members of the sdcTools core team are authorized to close issues. In that case the person who submitted the issue will be informated by e-mail according to his Github account. The closed issues are removed from the issue search lists on the Getting Support page of the UserSupport Wiki. For a complete list of all open and closed issues click on Search all issues.

Issues that are closed related to corrections of source code in one of the repostitories can be linked to the respective code commit by including a reference by issue number.

Clone this wiki locally