ISSUE_TEMPLATE.md

   1 Please read the following carefully before submitting this new issue.
   2
   3  - Please ensure, that you are really reporting a bug. When in doubt,
   4    post a message on https://groups.google.com/forum/#!forum/libmodbus
   5    or send an email to libmodbus@googlegroups.com
   6
   7  - Please do not open issues to ask questions about using libmodbus.
   8    Use the mailing list for this as there are many more people reading
   9    that list, who could help you.
  10
  11  - When using libmodbus from a distribution (Debian, Fedora...), please
  12    report the bug first in the bug tracker of the distribution. The
  13    reason for doing so is that the package maintainer should have a chance
  14    to look at the issue first as it might be a packaging error. If/when
  15    the package maintainer comes to the conclusion that is really an upstream
  16    bug, then he/she will usually report it here by himself/herself.
  17    This is because he/she is interested in staying in the notification chain
  18    to decide about a backport as soon as a bugfix is available.
  19    Otherwise you (distribution user) will be asked to do so explicitely.
  20
  21 When you get here and you are still convinced that you want report a bug:
  22
  23  - *Use a clear and decriptive title* for the issue to identify
  24
  25  - *Which version of libmodbus are you using?* you can obtain this information
  26    from your package manager or by running `pkg-config --modversion libmodbus`.
  27    You can provide the sha1 of the commit if you have fetched the code with `git`.
  28
  29  - *Which operating system are you using?*
  30
  31  - *Describe the exact steps which reproduce the problem* in as many details as
  32    possible. For example, the software/equipement which runs the Modbus server, how
  33    the clients are connected (TCP, RTU, ASCII) and the source code you are using.
  34
  35  - *Enable the debug mode*, libmodbus provides a function to display the content
  36    of the Modbus messages and it's very convenient to analyze issues
  37    (http://libmodbus.org/docs/latest/modbus_set_debug.html).
  38
  39 Good bug reports provide right and quick fixes!
  40
  41 Finally, thank you very much for using libmodbus and taking the time to
  42 file a good bug report. Doing so signals your respect for the developers.
  43
  44 The following template helps you to address the points above. Please delete
  45 everything up to and including the following line which starts with ---.
  46
  47 ---
  48
  49 ## libmodbus version
  50
  51   <libmodbus version or sha1 of the latest commit>
  52
  53 ## OS and/or distribution
  54
  55   <e.g. Windows, Linux... version>
  56
  57 ## Environment
  58
  59   <e.g. CPU architecture, 32 vs. 64 bit...>
  60
  61 ## Description
  62
  63   <...>
  64
  65 ## Expected behaviour
  66
  67   <...>
  68
  69 ## Actual behaviour
  70
  71   <...>
  72
  73 ## Steps to reproduce the behavior (commands or source code)
  74
  75   <...>
  76
  77 ## libmodbus output with debug mode enabled
  78
  79   <...>