PULL_REQUEST_TEMPLATE.md

Issue Type

• Feature Pull Request
• Bugfix Pull Request
• Documentation Pull Request

Summary

Code contribution checklist

1. The contribution fixes a single existing github issue, and it is linked to it.
2. The code is as simple as possible, readable and follows the idiomatic Go guidelines.
3. All new functionality is covered by automated test cases so the overall test coverage doesn't decrease.
4. No issues are reported when running make full-test.
5. Functionality not applicable to all users should be configurable.
6. Configurations should be exposed through Lambda function environment variables which are also passed as parameters to the CloudFormation and Terraform stacks defined as infrastructure code.
7. Global configurations set from the infrastructure stack level should also support per-group overrides using tags.
8. Tags names and expected values should be similar to the other existing configurations.
9. Both global and tag-based configuration mechanisms should be tested and proven to work using log output from various test runs.
10. The logs should be kept as clean as possible (use log levels as appropriate) and formatted consistently to the existing log output.
11. The documentation is updated to cover the new behavior, as well as the new configuration options for both stack parameters and tag overrides.
12. A code reviewer reproduced the problem and can confirm the code contribution actually resolves it.