# Contributing to docker-api
Contributing to docker-api isn't limited to just filing bugs, users are more than welcomed to make suggestions, report any issue they may find, and make pull requests to help make docker-api better.

## Working on docker-api
### Prerequisites
* The [rust toolchain](https://rustup.rs/)
* [Git](https://git-scm.com/)


### Getting docker-api
1. Fork a copy of our repo
2. Open up Git in an environment of your choice
3. Run the following

```sh
$ git clone https://github.com/YOUR-GITHUB-PROFILE-NAME/docker-api-rs.git
$ cd docker-api
```


### Please pay attention to
1. open an issue describing the feature/bug you wish to contribute first to start a discussion, explain why, what and how
2. use rustfmt, see below how to configure
3. try to write tests covering code you produce as much as possible, especially critical code branches
4. add notes/hightlights for the changelog in the pull request description


### Finding issues to fix
After you've forked and cloned our repo, you can find issues to work on by heading over to our [issues list](https://github.com/vv9k/docker-api-rs/issues)