# Contributing

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

## Bug reports

When [reporting a bug](https://github.com/InstituteforDiseaseModeling/laser-cholera/issues),
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.

## Documentation improvements

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

## Feature requests and feedback

The best way to send feedback is to
[file an issue](https://github.com/InstituteforDiseaseModeling/laser-cholera/issues).

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 code
  contributions are welcome :)

## Development setup

To set up `laser-cholera` for local development:

1. Fork [laser-cholera](https://github.com/InstituteforDiseaseModeling/laser-cholera)
   (look for the "Fork" button).

2. Clone your fork locally:

    ```bash
    git clone git@github.com:YOURGITHUBNAME/laser-cholera.git
    ```

3. Create a branch for local development:

    ```bash
    git checkout -b name-of-your-bugfix-or-feature
    ```

   Now you can make your changes locally.

4. When you're done making changes, run all the checks and the docs builder
   with one command:

    ```bash
    tox
    ```

5. Commit your changes and push your branch to GitHub:

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

6. Submit a pull request through the GitHub website.

## Pull-request guidelines

If you need some code review or feedback while you're developing the code,
just open the pull request — early drafts are fine.

For a PR to be ready to merge it should:

1. Include passing tests (run `tox`).
2. Update documentation when there's new API, functionality, etc.
3. Add a note to `CHANGELOG.md` about the changes.
4. Add yourself to `AUTHORS.md`.

## Tips

To run a subset of tests:

```bash
tox -e envname -- pytest -k test_myfeature
```

To run all the test environments in *parallel*:

```bash
tox -p auto
```
