CONTRIBUTING.md

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