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:

Report bugs at https://github.com/aparrish/pronouncingpy/issues
Fix bugs and implement features: Look through the GitHub issues for bugs to fix and features to implement!
Contribute to documentation and example code.
Submit feedback! File an issue at https://github.com/aparrish/pronouncingpy/issues.

Please note that contributions of any kind that are authored by large language models will not be accepted.

Get Started!

Ready to contribute? Here's how to set up pronouncing for local development.

Clone your fork locally:

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

Create a virtual environment and install your local copy of the package:
```
$ pip install -e .
```
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 flake8 and the tests:
```
$ flake8 pronouncing tests
$ python -m unittest
```

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

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

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.