bnpy is under active development. There will be many issues, especially bugs.

How to report a bug

If you discover a bug, please create a new issue on the project Issue Tracker here on the bitbucket web interface.

bitbucket.org/michaelchughes/bnpy-dev/issues/

For a particular good example, see Issue #14

A good bug report has the following properties:

• mentions the specific branch/commit/SHA for the code used
• provides a minimal example to reproduce the bug
• explains the expected behavior, and what was observed instead
• provides verbatim dumps of logfiles/stdout/stderr to help another person figure out what might have gone wrong

How to fix a bug

If you think you know how to fix the bug, go ahead and follow the usual process for a pull request.

For a good example, see this real pull request Pull Request #2

1) create a new branch named after the issue

git branch fix42-buginlearnalg

2) write code that fixes the bug (and if possible, tests that show the bug was fixed)

3) commit and push your changes to the bnpy-dev bitbucket repo

Make sure the commit message references the issue.

git commit -m "FIX Issue #42. Learn alg now runs without errors"
git push origin fix42-buginlearnalg

4) open a pull request on bitbucket's web interface

Name the pull request after the issue. Like "FIX Issue #42: bug in learning algorithm"

Add appropriate collaborators to the Reviewers field.

5) reviewers will discuss the fix and (if it works) will accept the request and merge into master / feature branch