Contributing

Report Bugs

Report bugs at https://github.com/pjhartout/fastwlk/issues.

If you are reporting a bug, please include:

• Your operating system name and version.

• Any details about your local setup that might be helpful in troubleshooting.

• Detailed steps to reproduce the bug.

Opening a Pull Request

To start on a new feature

$ git clone git://github.com/pjhartout/fastwlk
$ poetry install

To work inside the virtual environment provided by poetry:

$ poetry shell

Before committing changes, make sure you make feature branch:

$ git switch -c my-awesome-improvement

The above command is only available for git > 2.23. Otherwise:

$ git checkout -b my-awesome-improvement

After making your changes:

$ poetry shell
$ make test
$ make coverage