Trac good pratices

Generally speaking, you should have read, understood, and already be following the popular  How-to ask questions the smart way document (or  its french translation: de la bonne manière de poser des questions).

Declaring an issue

• the title should be explicit and should start with one of these words:
  • crash, freeze, error,
  • false positive (or negative),
  • undesired or unpredictable behaviour,
  • data loss, inconsistency
  • security
  • add a scenario for #xxx when the issue is an enhancement in the testsuite.
• if the issue is not testsuite related, you should create another issue, labelled add a scenario for #xxx, where xxx is the ID of the original issue you created.
• everytime it's possible, the summary should mention the cause that really makes the problem occur, not only the fact that the problem occurs. Examples:
  • add user doesn't work: bad, too much general. It will just renders the search engine useless if all bugs have a too general summary.
  • crash on add user: better, but still too general
  • crash on add user when --login missing: this one is quite good. You know exactly how to reproduce the bug.
  • crash on add user with multiple --lastname: this one's good too.
• all CLI commands and their output, all python tracebacks go into triple accolades, like this :

  root@host # example command
  example: command not found
  

Closing an issue

• beyond than choosing a reason in the combo-box (fixed, invalid, worksforme, etc), you should indicate an explanation in good human terms.
  • if choosing fixed, the reason is often commited in source tree, and its totally sufficient. It can be also included in debian package <package>-<version> and above.. If you're closing a bug which has been fixed as a side effect coming from another fix, or you just reminds the issue is fixed since a while, you can just indicate it when closing: fix commited in the repo a while before tag licorn-<version> as far I can remember..
  • if choosing invalid, you should explicitely mention why the issue is invalid and doesn't concern Licorn®.
  • if choosing worksforme, you should put an exhaustive explanation (with commands and output when related) of what you tried, before coming to the conclusion that you can't reproduce the bug.