google / gcp_scanner

A comprehensive scanner for Google Cloud
Apache License 2.0
311 stars 97 forks source link

move PR template to `.github` directory as its not part of the source code #66

Closed sudiptob2 closed 1 year ago

sudiptob2 commented 1 year ago

The pull_request_template.md helps the user by providing a checklist while creating a PR. However, it's not a part of the main source code. It's an extension for GitHub. Hence it should be moved into .github directory.

Also in the future we might need to support multiple PR templates for multiple issue types (such as bug-fix, feature, ci, docs, etc.). Therefore, it's better to put it under the .github/PULL_REQUEST_TEMPLATE

Ref: GitHub official doc