From 7612ce2029de1eac698ebc2ba617c4fbd738127f Mon Sep 17 00:00:00 2001 From: Stéphane Raimbault Date: Tue, 17 May 2016 23:16:13 +0200 Subject: [PATCH] Github's contributing and issue template files --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ ISSUE_TEMPLATE.md | 13 +++++++++++++ README.md | 25 ++++++------------------- 3 files changed, 48 insertions(+), 19 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 ISSUE_TEMPLATE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3466193 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +How Do I Submit A Good Bug Report? +---------------------------------- + +Please, don't send direct emails to Stéphane Raimbault unless you want +commercial support. + +Take care to read the documentation at http://libmodbus.org/documentation/. + +- *Be sure it's a bug before creating an issue*, in doubt, post a message on + https://groups.google.com/forum/#!forum/libmodbus or send an email to + libmodbus@googlegroups.com + +- *Use a clear and decriptive title* for the issue to identify + +- *Which version of libmodbus are you using?* you can obtain this information +from your package manager or by running `pkg-config --modversion libmodbus`. +You can provide the sha1 of the commit if you have fetched the code with `git`. + +- *Which operating system are you using?* + +- *Describe the exact steps which reproduce the problem* in as many details as +possible. For example, the software/equipement which runs the Modbus server, how +the clients are connected (TCP, RTU, ASCII) and the source code you are using. + +- *Enable the debug mode*, libmodbus provides a function to display the content +of the Modbus messages and it's very convenient to analyze issues +(http://libmodbus.org/docs/latest/modbus_set_debug.html). + +Good bug reports provide right and quick fixes! diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..19d08a2 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,13 @@ +### libmodbus version + +### Operating system + +### Description of the Modbus network (server, client, links, etc) + +### Expected behavior + +### Actual behavior + +### Steps to reproduce the behavior (commands or source code) + +### libmodbus output with debug mode enabled diff --git a/README.md b/README.md index 28455eb..d41e5f7 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,14 @@ automake libtool`. Documentation ------------- +The documentation is available [online](http://libmodbus.org/documentation) or +as manual pages after installation. + The documentation is based on [AsciiDoc](http://www.methods.co.nz/asciidoc/). Only man pages are built by default with `make` command, you can run `make htmldoc` in *docs* directory to generate HTML files. -The documentation is also available [online](http://libmodbus.org/documentation). - Testing ------- @@ -83,21 +84,7 @@ By default, all TCP unit tests will be executed (see --help for options). It's also possible to run the unit tests with `make check`. -Report a Bug ------------- - -Before reporting a bug, take care to read the documentation (RTFM!) and to -provide enough information: - -1. libmodbus version -2. OS/environment/architecture -3. libmodbus backend (TCP, RTU, IPv6) -3. Modbus messages when running in debug mode (`man modbus_set_debug`) - -To report your problem, you can: - -* fill a bug report on the issue tracker . -* or send an email to the libmodbus mailing list [libmodbus@googlegroups.com](https://groups.google.com/forum/#!forum/libmodbus). +To report a bug or to contribute +-------------------------------- -If your prefer live talk when your're looking for help or to offer contribution, -there is also a channel called #libmodbus on Freenode. +See [CONTRIBUTING](CONTRIBUTING.md) document. \ No newline at end of file -- libgit2 0.21.4