Skip to content

Commit

Permalink
Explain how to report issues
Browse files Browse the repository at this point in the history
  • Loading branch information
WhyNotHugo committed Apr 5, 2024
1 parent 841c8d3 commit 32b658b
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 32b658b

Please sign in to comment.