Merge pull request #312 from terraform-google-modules/contributing

Add contributing file
This commit is contained in:
lcaggio 2021-09-30 14:08:12 +02:00 committed by GitHub
commit 0bceb328d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions

16
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,16 @@
# Contributing
We welcome any contributions on bugs, or feature requests you would like to submit!
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`
* Make sure Terraform linting is ok (hint: `terraform format`)
* Make sure tests pass!<br>`pytest # in the root folder`
* Make sure any changes to variables and outputs are reflected in READMEs<br>`./tools/tfdoc.py [changed folder]`
* Push to the Branch<br>`git push origin feature/AmazingFeature`
* Open a Pull Request
When implementing your new feature, please follow our [core design principles](./MANIFESTO.md#core-design-principles).