From 0832184896ababac7ee696625bfa32cc7b596815 Mon Sep 17 00:00:00 2001 From: Matias Fontanini Date: Sat, 6 Feb 2016 16:04:07 -0800 Subject: [PATCH] Add CONTRIBUTING.md file --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ README.md | 5 +++++ 2 files changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..07c612c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +Bug reports and enhancements to the library are really valued and appreciated! + +# Bug reports + +If you find a bug, please report it! Bugs on the library are taken seriously +and a patch for them is usually pushed on the same day. + +When reporting a bug, please make sure to indicate the platform (e.g. GNU/Linux, Windows, OSX) +in which you came across the issue, as this is essential to finding the cause. + +## Packet parsing bugs + +If you find a bug related to packet parsing (e.g. a field on a packet contains an +invalid value), please try to provide a pcap file that contains the packet that +was incorrectly parsed. Doing this will make it very simple to find the issue, plus +you will be asked to provide this file anyway, so this just makes things +easier. + +# Pull requests + +Pull requests are very welcomed. When doing a pull request please: + +* Base your PR branch on the `develop` branch. This is **almost always** pointing to the +same commit as `master`, so you shouldn't have any issues changing the destination branch +to `develop` at the time you try to do the pull request if you based your code on `master`. +* Your code will be compiled and tests will be run automatically by the travis and +appveyor CI tools. If your code has issues on any of the tested platforms (GNU/Linux, Windows +and OSX), please fix it or otherwise the PR won't be merged. diff --git a/README.md b/README.md index 5253ff7..13591e6 100644 --- a/README.md +++ b/README.md @@ -119,3 +119,8 @@ You might want to have a look at the examples located in the "examples" directory. The same samples can be found online at: http://libtins.github.io/examples/ + +## Contributing ## + +If you want to report a bug or make a pull request, please have a look at +the [contributing](CONTRIBUTING.md) file before doing so. \ No newline at end of file