|
| 1 | +# Contributing to terraform-aws-foundation |
| 2 | + |
| 3 | +Contributing to terraform-aws-foundation is very welcome. The following are some |
| 4 | +guidelines and instructions to help those interested. |
| 5 | + |
| 6 | +These are intended to help you verify that you're submitting well-formed pull |
| 7 | +requests and opening useful issues for terraform-aws-foundation. Doing so saves |
| 8 | +the maintainers time by communicating the format that works best and what required |
| 9 | +information and documentation is typically needed. |
| 10 | + |
| 11 | +## Feature requests |
| 12 | +[feature-requests]: #feature-requests |
| 13 | + |
| 14 | +To ask or discuss new features for terraform-aws-foundation, please |
| 15 | +[open an issue](https://github.com/fpco/terraform-aws-foundation/issues) and use |
| 16 | +the provided feature request template. |
| 17 | + |
| 18 | +## Bug reports and issues |
| 19 | +[bug-reports]: #bug-reports |
| 20 | + |
| 21 | +To report bugs or other issues with terraform-aws-foundation please |
| 22 | +[open an issue](https://github.com/fpco/terraform-aws-foundation/issues) and use |
| 23 | +the provided template to include all necessary details. |
| 24 | + |
| 25 | +Bugs should not be feature requests in disguise. We're happy to entertain and |
| 26 | +discuss new feature requests but please use the feature request template for issues. |
| 27 | + |
| 28 | +## Pull Requests |
| 29 | +[pull-requests]: #pull-requests |
| 30 | + |
| 31 | +Please [open a PR](https://github.com/fpco/terraform-aws-foundation/pulls) |
| 32 | +and follow the provided pull request template as closely as you're able to. |
| 33 | + |
| 34 | +We tend to use the "fork and pull" model for outside contributors where |
| 35 | +contributors push changes to their personal fork and then create pull requests |
| 36 | +to bring those changes into the terraform-aws-foundation repository. |
| 37 | + |
| 38 | +For more information on this using this model please see the Github documentation |
| 39 | +[here](https://help.github.com/en/articles/about-collaborative-development-models), |
| 40 | +or for more information on how pull requests work on Github please see the documentation |
| 41 | +[here](https://help.github.com/en/articles/about-pull-requests). |
| 42 | + |
| 43 | +Thank you for contributing! |
0 commit comments