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

If you are reporting a bug, please include:

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

once_only could always use more and better documentation!

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

If you are proposing a feature:

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

Clone your fork locally:

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

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ cd once_only/
$ make virtual-environment
$ make install-pre-commit
```
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 our tests and automatically format everything according to our rules:
```
$ make lint
```
Often, the linters can fix errors themselves, so if you get failures, run make lint again to see if any errors need human intervention.

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 check the generated API documentation.
The pull request will be tested on python 3.7, 3.8, 3.9, and 3.10.

A reminder for the maintainers on how to deploy.