Contributing

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

You can contribute in many ways:

Types of contributions

Report bugs

Report bugs at https://github.com/amjith/fuzzyfinder/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.

Fix bugs

Look through the GitHub issues for bugs. Anything tagged with bug is open to whomever wants to implement it.

Implement features

Look through the GitHub issues for features. Anything tagged with feature is open to whomever wants to implement it.

Write documentation

fuzzyfinder could always use more documentation, whether as part of the official fuzzyfinder docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit feedback

The best way to send feedback is to file an issue at https://github.com/amjith/fuzzyfinder/issues.

Get started!

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

Fork the fuzzyfinder repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/fuzzyfinder.git

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the tests and type checks, and respect the project’s code style. This project uses tox for running tests on multiple versions of Python (with pytest and coverage), for type checking (with mypy), and for formatting (with ruff):
```
$ pip install tox
$ tox -e py310,py311,py312,py313  # add any other supported versions
$ tox -e typing
$ tox -e style
```

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.