Skip to content

Submitting an issue

rhe-reliatec edited this page May 4, 2022 · 7 revisions

So you have discovered a bug in LibreClinica and you want to report it: what steps should you take?

To report a bug by creating a new issue, first of all you must have a github-account. Now go to the issues-tab of LibreClinica and make sure that no one else has already submitted the same issue.
If you find that your issue has already been described by someone else, feel free to add comments to that issue, if you think that will help diagnose or solve the problem.

If you have searched the existing issues and you are still convinced that you have found a new one, create a new issue and enter the following:

  • give a short description of your LibreClinica-configuration: ideally this would include your operating system plus version, jdk-version, tomcat-version, postgresql-version and (of course) LibreClinica-version.
  • give a short description of the bug: for example "there is no expand-icon in for the icon-key-part in the left toolbar for view-study-subject"
  • describe the requirements to reproduce the bug: for example "for this bug you need a study with at least one subject"
  • describe the steps that must be taken to reproduce the bug: be as precise as possible, for example "click on subject-matrix; select a study-subject by clicking on the magnifier-icon; you are now in view-study-subject; in the left toolbar, click on the collapse-icon for icon-key"
  • describe the result: "the icons disappear and there's no option to get them back"
  • describe the expected result, the correct outcome: "the icons should disappear and the title 'Icon Key' should still be visible, plus the expand-icon, so that the cons can be shown again "
    There is an issue template available in the repository.

Please keep in mind that the smaller the issue the faster it gets done. So there should be a separate issue for each bug.

Clone this wiki locally