Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit fc47c3c

Browse files
Mike McGirrketzacoatl
authored andcommitted
Fill out the initial contribution guide. Provide templates for PR's and issues.
1 parent 15fcd37 commit fc47c3c

File tree

6 files changed

+126
-0
lines changed

6 files changed

+126
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in terraform-aws-foundation
4+
---
5+
6+
Please follow the steps below for reporting a bug:
7+
8+
Make sure that you are using the latest [release](https://github.com/fpco/terraform-aws-foundation/releases).
9+
Bugs in a previous release may have been fixed in newer release!
10+
11+
Please use the following schema for your bug report:
12+
13+
### General summary/comments (optional)
14+
15+
### Steps to reproduce
16+
17+
Include any example code to recreate the problem if able to and relevant.
18+
19+
### Expected
20+
21+
What you expected to see and happen.
22+
23+
### Actual
24+
25+
What actually happened.
26+
27+
### Version
28+
29+
Which version where you using when you encountered this bug?
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Feature Request
3+
about: Request a feature be added to terraform-aws-foundation, or discuss such a feature.
4+
---
5+
6+
Make sure that you are using the latest [release](https://github.com/fpco/terraform-aws-foundation/releases).
7+
8+
Please state as clearly as possible what feature you are recommending and
9+
the motivation for why such a feature should be added.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Question
3+
about: Ask a question about terraform-aws-foundation usage
4+
---
5+
6+
7+
If you have a question that isn't covered by the
8+
[repository examples](https://github.com/fpco/terraform-aws-foundation/tree/master/examples)
9+
or the [terraform module documentation](https://registry.terraform.io/modules/fpco) please reach out.
10+
11+
If your question is more generally about any of the tools used in the repository, it is advised to reach
12+
out to the relevant help resources for that tool. Your question is more likely to get answered and will have
13+
more visibility.
14+
15+
Please make sure that you are using the latest [release](https://github.com/fpco/terraform-aws-foundation/releases).
16+
17+
### terraform-aws-version
18+
19+
### question

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Pull request template
3+
about: Make a PR to terraform-aws-foundation
4+
---
5+
6+
Please include the following in your PR:
7+
8+
Please also note that these are not hard requirements, but merely serve to define
9+
what maintainers are looking for in PR's. Including these will more likely lead
10+
to your PR being reviewed and accepted.
11+
12+
- [ ] Update the changelog
13+
- [ ] Make sure that modules and files are documented. This can be done inside the module and files.
14+
- [ ] Make sure that new modules directories contain a basic README.md file.
15+
- [ ] Make sure that the module is added to [tests/main.tf](https://github.com/fpco/terraform-aws-foundation/blob/master/tests/main.tf)
16+
- [ ] Make sure that the linting passes on CI.
17+
- [ ] Make sure that there is an up to date example for your code:
18+
- For new `modules` this would entail example code for how to use the module or some explanation in the module readme.
19+
- For new examples please provide a README explaining how to run the example. It's also ideal to provide a basic makefile to use the example as well.
20+
- [ ] Make sure that there is a manual CI trigger that can test the deployment.

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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!

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,9 @@ As the collection of modules is composable into an endless array of possibilitie
5858
there is no explicit requirement to use all of these tools, you can just as easily
5959
use the IAM management modules and nothing else, or build a more complete stack
6060
with these modules.
61+
62+
63+
## Contributing, Issues, and Feature Requests
64+
65+
Please see [CONTRIBUTING.md](https://github.com/fpco/terraform-aws-foundation/blob/master/CONTRIBUTING.md) for
66+
more information.

0 commit comments

Comments
 (0)