diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a06e829..c448410 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -26,7 +26,7 @@ assignees: "" ## Screenshots/Logs -## Impacted Application/Tools/Utility Version: +## Impacted Application/Tools/Utility Version -## Environment: +## Environment ## Affected Documentation + - [ ] README.md - [ ] API Documentation - [ ] Developer Guide diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 41b5516..e9cbd7b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -22,7 +22,7 @@ This can be anything from CI tool integration, Security feature (use Security-De ## Benefits -### Example: +### Example ## Additional Information diff --git a/.github/ISSUE_TEMPLATE/security_vulnerability_report.md b/.github/ISSUE_TEMPLATE/security_vulnerability_report.md index 0dd29d0..a2d522a 100644 --- a/.github/ISSUE_TEMPLATE/security_vulnerability_report.md +++ b/.github/ISSUE_TEMPLATE/security_vulnerability_report.md @@ -23,7 +23,7 @@ assignees: "" ## Suggested Mitigation or Fix -### CVSS Score (Optional): +### CVSS Score (Optional) ## Additional Information diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_pr_template.md b/.github/PULL_REQUEST_TEMPLATE/bug_pr_template.md new file mode 100644 index 0000000..446f20d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_pr_template.md @@ -0,0 +1,51 @@ +## Description + + + +### Type of bug fix + +Link to GitHub Issue: + +Please select or add the type of bug fixed. + +- [ ] App Code (non-breaking change which fixes an issue) +- [ ] CI/CD pipeline (please specify impacted component) +- [ ] Configuration (please specify impacted component) + +## How has this been tested? + + + +## Checklist for Author + +- [ ] The PR follows below contribution conventions + - [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description] +- [ ] I have tested the bug fix thoroughly and attached test evidences confirming changes works as expected +- [ ] I have updated the documentation to reflect bug fixes (if applicable) +- [ ] My changes generate no new warnings or errors +- [ ] Checks for unused files +- [ ] Checks for changes not related to this issue + +## Additional notes for reviewer + + + +## Checklist for Reviewer + +- [ ] The PR follows contribution guidelines +- [ ] I have reviewed the author checklist +- [ ] I have tested the changes locally are working as expected diff --git a/.github/PULL_REQUEST_TEMPLATE/document_pr_template.md b/.github/PULL_REQUEST_TEMPLATE/document_pr_template.md new file mode 100644 index 0000000..72222e8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/document_pr_template.md @@ -0,0 +1,57 @@ +## Description + + + +### Affected Documentation + +Link to GitHub Issue: + +Affected Documentation: + +- [ ] README +- [ ] Setup Instructions +- [ ] API Documentation +- [ ] Developer Guide +- [ ] Contribution Guide +- [ ] Other (please specify): + +## How Has This Been Tested? + +Please describe how the changes to documentation were reviewed. If applicable, include instructions on how to view or +test the updated documentation. + +- [ ] Documentation preview checked in markdown renderer +- [ ] Links and images tested for correctness + + + +## Checklist for Author + +- [ ] The PR follows below contribution conventions + - [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description] +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my documentation to reflect the code changes, spelling and is clearly accurate +- [ ] I have tested the documentation for correctness and if required added evidences(e.g., links, images) +- [ ] My changes generate no new warnings or errors +- [ ] Checks for unused files +- [ ] Checks for changes not related to this issue + +## Additional notes for reviewer + + + +## Checklist for Reviewer + +- [ ] The PR follows contribution guidelines +- [ ] Reviewed documentation for accuracy and rendering diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_pr_template.md b/.github/PULL_REQUEST_TEMPLATE/feature_pr_template.md new file mode 100644 index 0000000..5bb419c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_pr_template.md @@ -0,0 +1,53 @@ +## Description + + + +### Type of feature request + +Link to GitHub Issue: + +Please add/delete options that are not relevant. + +- [ ] App code +- [ ] Testing +- [ ] CI/CD pipeline +- [ ] DevSecOps +- [ ] Configuration + +## How Has This Been Tested? + + + +## Checklist for Author + +- [ ] The PR follows below contribution conventions + - [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description] +- [ ] I have tested the enhancement thoroughly and attached test evidences confirming changes works as expected +- [ ] I have updated the documentation to reflect enhancement (if applicable) +- [ ] My changes generate no new warnings or errors and added tests that prove my feature PR is effective +- [ ] Checks for unused files +- [ ] Checks for changes not related to this issue + +## Additional notes for reviewer + + + +## Checklist for Reviewer + +- [ ] The PR follows contribution guidelines +- [ ] I have reviewed the author checklist +- [ ] I have tested the changes locally are working as expected diff --git a/.github/PULL_REQUEST_TEMPLATE/generic_pr_template.md b/.github/PULL_REQUEST_TEMPLATE/generic_pr_template.md new file mode 100644 index 0000000..d4644ea --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/generic_pr_template.md @@ -0,0 +1,45 @@ +## Description + + + +### Type of Change + +Link to GitHub Issue: + +## How has this been tested? + + + +## Checklist for Author + +- [ ] The PR follows below contribution conventions + - [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description] +- [ ] I have tested the changes thoroughly and attached test evidences confirming changes works as expected +- [ ] I have updated the documentation to reflect changes (if applicable) +- [ ] My changes generate no new warnings or errors +- [ ] Checks for unused files +- [ ] Checks for changes not related to this issue + +## Additional notes for reviewer + + + +## Checklist for Reviewer + +- [ ] The PR follows contribution guidelines +- [ ] I have reviewed the author checklist +- [ ] I have tested the changes locally are working as expected diff --git a/.github/PULL_REQUEST_TEMPLATE/security_vulnerability_pr_template.md b/.github/PULL_REQUEST_TEMPLATE/security_vulnerability_pr_template.md new file mode 100644 index 0000000..406a013 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/security_vulnerability_pr_template.md @@ -0,0 +1,53 @@ +## Description + + + +### Type of Security Vulnerability + +Link to GitHub Issue: + +Please select or add the type of Security Vulnerability fixed. + +- [ ] App Code (non-breaking change which fixes an issue) +- [ ] App Code Dependency +- [ ] Container Image vulnerability +- [ ] IAC vulnerability + +## How has this been tested? + + + +## Checklist for Author + +- [ ] The PR follows below contribution conventions + - [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type( + scope): issue_reference message + - [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description] +- [ ] I have tested the security vulnerability thoroughly and attached test evidences confirming changes works as + expected +- [ ] I have updated the documentation to reflect bug fixes (if applicable) +- [ ] My changes generate no new warnings or errors +- [ ] Checks for unused files +- [ ] Checks for changes not related to this issue + +## Additional notes for reviewer + + + +## Checklist for Reviewer + +- [ ] The PR follows contribution guidelines +- [ ] I have reviewed the author checklist +- [ ] I have tested the changes locally are working as expected diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e4483cf --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +# Instructions + +Click the **Preview** tab and select a relevant PR template. + +Please use generic template for other types of changes. + +- [Feature](?expand=1&template=feature_pr_template.md) +- [Bug](?expand=1&template=bug_pr_template.md) +- [Document](?expand=1&template=document_pr_template.md) +- [Security Vulnerability](?expand=1&template=security_vulnerability_pr_template.md) +- [Generic](?expand=1&template=generic_pr_template.md)