From 32b658b6179a307494035dfa582f8f54868cce2c Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Fri, 5 Apr 2024 13:58:41 +0200 Subject: [PATCH] Explain how to report issues --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..69e83c2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to python-barcode + +## Bug reports + +Please make sure that you take the following steps when reporting issues: + +Ensure that you are using the latest version. You bug may already have been +fixed. + +Search existing issues to ensure that it was not previously included. Be sure to +search closed issues too, your issue may have been fixed recently. + +In case that the generated output is not correct, please mention: + +- What input did you provide? +- What output did you get? +- What output do you think you should have obtained? + +In case of crashes, please copy the full stack trace and **at least** the line +from your code that reproduces the crash. + +Trying to understand and debug any error is a lot easier if you provide a small +portion of code that I can run myself to reproduce the error.