Add a ISSUE_TEMPLATE/config.yml to force users to use the provided templates. This prevents submitting blank issues to the repository, either the bug template or feature template will need to be used and aid maintaining the project
Update bug and issue reports to provide more accountability from the submitter to work through some common troubleshooting before submitting issues and ensure feature requests are able to be performed if said features are in the upstream provider
Update pull request template to provide more detail when submitting a PR
These changes are intended to help resolve issues more quickly and with less effort. Users should work through some common troubleshooting steps (removing the .terraform cache and re-initializing) and provide more detail (terraform version and provider versions) when submitting bug reports. Users should also take the time to ensure the feature they are after is exposed in the upstream AWS provider before requesting in the modules. This should help alleviate a lot of common issues before hitting the queue (hopefully)
Also, the <!-- ... --> wrapped text is used to provide the context to the submitter without cluttering the rendered request (they see it when filling out the request, but the final rendered version submitted does not contain that text in the browser)
Description
ISSUE_TEMPLATE/config.yml
to force users to use the provided templates. This prevents submitting blank issues to the repository, either the bug template or feature template will need to be used and aid maintaining the projectThese changes are intended to help resolve issues more quickly and with less effort. Users should work through some common troubleshooting steps (removing the .terraform cache and re-initializing) and provide more detail (terraform version and provider versions) when submitting bug reports. Users should also take the time to ensure the feature they are after is exposed in the upstream AWS provider before requesting in the modules. This should help alleviate a lot of common issues before hitting the queue (hopefully)
Also, the
<!--
...-->
wrapped text is used to provide the context to the submitter without cluttering the rendered request (they see it when filling out the request, but the final rendered version submitted does not contain that text in the browser)