Contributing#

# Contributing

Thank you for your interest in improving this project. This project is open-source under the MIT [license](https://github.com/xransum/valkyrie-tools/blob/main/LICENSE) and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

## How to Report a Bug

Report bugs on the [Issue Tracker](https://github.com/xransum/valkyrie-tools/issues).

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?

  • Which version of this project are you using?

  • What did you do?

  • What did you expect to see?

  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

## How to Request a Feature

Request features on the [file an issue](https://github.com/xransum/valkyrie-tools/issues).

## How to Contribute Code

  1. Fork the project.

  2. Create a new branch.

  3. Make your changes.

  4. Update the documentation.

  5. Commit your changes.

  6. Push your branch.

  7. Open a pull request.

## Code of Conduct

This project is governed by a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [me@kevin-haas.com](mailto:me@kevin-haas.com).