CONTRIBUTING.md

   1 How Do I Submit A Good Bug Report?
   2 ----------------------------------
   3
   4 Please, don't send direct emails to Stéphane Raimbault unless you want
   5 commercial support.
   6
   7 Take care to read the documentation at http://libmodbus.org/documentation/.
   8
   9 - *Be sure it's a bug before creating an issue*, in doubt, post a message on
  10   https://groups.google.com/forum/#!forum/libmodbus or send an email to
  11   libmodbus@googlegroups.com
  12
  13 - *Use a clear and descriptive title* for the issue to identify
  14
  15 - *Which version of libmodbus are you using?* you can obtain this information
  16 from your package manager or by running `pkg-config --modversion libmodbus`.
  17 You can provide the sha1 of the commit if you have fetched the code with `git`.
  18
  19 - *Which operating system are you using?*
  20
  21 - *Describe the exact steps which reproduce the problem* in as many details as
  22 possible. For example, the software/equipment which runs the Modbus server, how
  23 the clients are connected (TCP, RTU, ASCII) and the source code you are using.
  24
  25 - *Enable the debug mode*, libmodbus provides a function to display the content
  26 of the Modbus messages and it's very convenient to analyze issues
  27 (http://libmodbus.org/docs/latest/modbus_set_debug.html).
  28
  29 Good bug reports provide right and quick fixes!