algo/CONTRIBUTING.md

14 lines
761 B
Markdown
Raw Normal View History

2016-10-16 15:47:35 +00:00
### Filing New Issues
* Check that your issue is not already described in the [FAQ](docs/faq.md), [troubleshooting](docs/troubleshooting.md) docs, or an [existing issue](https://github.com/trailofbits/algo/issues)
2017-02-07 22:08:44 +00:00
* Did you remember to install the dependencies for your operating system prior to installing Algo?
* We only support modern clients, e.g. macOS 10.11+, iOS 9+, Windows 10+, Ubuntu 17.04+, etc.
2017-04-03 19:43:32 +00:00
* Cloud provider support is limited to DO, AWS, GCE, and Azure. Any others are best effort only.
* If you need to file a new issue, fill out any relevant fields in the Issue Template.
2016-08-24 07:27:29 +00:00
2016-10-16 15:47:35 +00:00
### Pull Requests
2016-08-24 07:27:29 +00:00
2017-02-07 22:01:31 +00:00
* Run [ansible-lint](https://github.com/willthames/ansible-lint) or [shellcheck](https://github.com/koalaman/shellcheck) on any new scripts
2017-02-07 22:08:44 +00:00
Thanks!