Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

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.

Fix Bugs

Look through the GitHub issues for bugs. Anything labeled as a bug is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for relevant features. If there relevant improvements to a feature, this is open to whoevver wants to implement it. If there are additional features that have potential to be included, this is also open to whoever wants to implement this. Please follow appropriate code quality guidelines.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such. Please include documentation for any features that you include.

Submit Feedback

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome and encouraged.

Get Started!

Ready to contribute? Here’s how to set up textfeatureinfo for local development.

Download a copy of textfeatureinfo locally.
Install textfeatureinfo using poetry:
```
$ poetry install
```
Use git (or similar) to create a branch for local development and make your changes:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.
Commit your changes and open a pull request.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

The pull request should include additional tests if appropriate.
If the pull request adds functionality, the docs should be updated.
The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct

Please note that the textfeatureinfo project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms. Failure to follow the Code of Conduct is actionable and the project team will respond in a way that is appropriate for the circumstance.