2021-09-30 03:32:09 -07:00
|
|
|
# Contributing
|
|
|
|
|
|
2021-09-30 03:37:40 -07:00
|
|
|
We welcome any contributions on bugs, or feature requests you would like to submit!
|
2021-09-30 03:32:09 -07:00
|
|
|
|
2021-09-30 03:37:40 -07:00
|
|
|
The basic process is pretty simple:
|
|
|
|
|
|
|
|
|
|
* Fork the Project
|
|
|
|
|
* Create your Feature Branch<br>`git checkout -b feature/AmazingFeature`
|
|
|
|
|
* Commit your Changes<br>`git commit -m 'Add some AmazingFeature`
|
2022-01-04 18:16:01 -08:00
|
|
|
* Make sure tests pass!<br>`pytest # in the root or `tests` folder`
|
2021-12-15 02:41:51 -08:00
|
|
|
* Make sure Terraform linting is ok (hint: `terraform fmt -recursive` in the root folder)
|
2021-09-30 03:37:40 -07:00
|
|
|
* Make sure any changes to variables and outputs are reflected in READMEs<br>`./tools/tfdoc.py [changed folder]`
|
2021-09-30 03:39:50 -07:00
|
|
|
* Push to the Branch<br>`git push origin feature/AmazingFeature`
|
2021-09-30 03:32:09 -07:00
|
|
|
* Open a Pull Request
|
|
|
|
|
|
2021-09-30 03:37:40 -07:00
|
|
|
When implementing your new feature, please follow our [core design principles](./MANIFESTO.md#core-design-principles).
|
