# 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/abilian/abilian-devtools/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" and "help wanted" is open to whoever wants to implement it.

### Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

### Write Documentation

Abilian DevTools could always use more documentation, whether as part  of the official Nua Cloud Platform 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/abilian/abilian-devtools/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 contributions are welcome :)

## Get Started!

Ready to contribute? Here\'s how to set up [nua]{.title-ref} for local development.

1. Fork the [repo](https://github.com/abilian/abilian-devtools/) on GitHub.

2. Clone your fork locally:

```console
$ git clone git@github.com:your_name_here/abilian-devtools.git
```

3. Install your local copy into a virtualenv. Assuming you have Poetry installed, this is how you set up your fork for local development:

```console
$ cd abilian-devtools/
$ poetry shell
$ poetry install
```

4. Create a branch for local development:

```console
$ git checkout -b name-of-your-bugfix-or-feature
```

   Now you can make your changes locally.

5. When you're done making changes, check that your changes pass the various linters and the tests, including testing other Python versions and testing subpackages in isolation with nox:

```console
make
# or
nox
```

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

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

7. Submit a pull request through the GitHub website.

## Pull Request Guidelines

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

1. The pull request should include tests.
2. 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.md.
3. The pull request should work for Python 3.10 and later versions.

## Tips

To run a subset of tests:

``` shell
$ pytest tests/...
```

## Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run:

``` shell
$ poetry version patch # possible: major / minor / patch
$ git push
$ git push --tags
```
