Skip to content

Commit 64fd911

Browse files
abhisheksr01abhisheksr01
committed
docs(pull_request_template): #361 add PR templates for different issue types
1 parent a70d921 commit 64fd911

File tree

10 files changed

+275
-4
lines changed

10 files changed

+275
-4
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ assignees: ""
2626
## Screenshots/Logs
2727
<!-- If applicable, please attach any screenshots, logs, or error messages that may help in reproducing the issue. -->
2828

29-
## Impacted Application/Tools/Utility Version:
29+
## Impacted Application/Tools/Utility Version
3030

3131
<!--
3232
- Version: [e.g. v1.0.0]
@@ -35,7 +35,7 @@ assignees: ""
3535
- gradle etc
3636
-->
3737

38-
## Environment:
38+
## Environment
3939
<!--
4040
- OS: [e.g. Ubuntu 20.04]
4141
- Java Version: [e.g. OpenJDK 11]

‎.github/ISSUE_TEMPLATE/document_improvement.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ assignees: ""
1414
<!-- Provide the suggested changes or additions to the documentation, including code snippets if applicable. -->
1515

1616
## Affected Documentation
17+
1718
- [ ] README.md
1819
- [ ] API Documentation
1920
- [ ] Developer Guide

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This can be anything from CI tool integration, Security feature (use Security-De
2222
## Benefits
2323
<!-- Describe the benefits of this feature and why it should be prioritized. -->
2424

25-
### Example:
25+
### Example
2626
<!-- - Provide examples of how the feature will work or how it will be used, if possible. -->
2727

2828
## Additional Information

‎.github/ISSUE_TEMPLATE/security_vulnerability_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ assignees: ""
2323
## Suggested Mitigation or Fix
2424
<!-- If known, provide any suggestions for mitigating the vulnerability or fixing the issue. -->
2525

26-
### CVSS Score (Optional):
26+
### CVSS Score (Optional)
2727
<!-- If you are aware of the Common Vulnerability Scoring System (CVSS) score, please include it to help assess the severity. -->
2828

2929
## Additional Information

‎.github/PULL_REQUEST_TEMPLATE/bug_pr_template.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Description
2+
3+
<!--
4+
Please provide a summary of the bug being fixed, the motivation for fixing it, and any context regarding how it impacts the functionality or users.
5+
Please specify if this PR has dependency on any other changes.
6+
-->
7+
8+
### Type of bug fix
9+
10+
Link to GitHub Issue:
11+
12+
Please select or add the type of bug fixed.
13+
14+
- [ ] App Code (non-breaking change which fixes an issue)
15+
- [ ] CI/CD pipeline (please specify impacted component)
16+
- [ ] Configuration (please specify impacted component)
17+
18+
## How has this been tested?
19+
20+
<!--
21+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce the bug, and describe the expected behavior after the fix.
22+
23+
- Test case 1 (please describe)
24+
- Test case 2 (please describe)
25+
26+
Please attach relevant evidences supporting the test execution.
27+
-->
28+
29+
## Checklist for Author
30+
31+
- [ ] The PR follows below contribution conventions
32+
- [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
33+
scope): issue_reference message
34+
- [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
35+
scope): issue_reference message
36+
- [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description]
37+
- [ ] I have tested the bug fix thoroughly and attached test evidences confirming changes works as expected
38+
- [ ] I have updated the documentation to reflect bug fixes (if applicable)
39+
- [ ] My changes generate no new warnings or errors
40+
- [ ] Checks for unused files
41+
- [ ] Checks for changes not related to this issue
42+
43+
## Additional notes for reviewer
44+
45+
<!-- Add any information that can be useful to the reviewer -->
46+
47+
## Checklist for Reviewer
48+
49+
- [ ] The PR follows contribution guidelines
50+
- [ ] I have reviewed the author checklist
51+
- [ ] I have tested the changes locally are working as expected

‎.github/PULL_REQUEST_TEMPLATE/document_pr_template.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Description
2+
3+
<!--
4+
Please include a summary of the changes made to the documentation. Explain the motivation for the change and the impact on the users or developers who rely on this documentation.
5+
Please specify if this PR has dependency on any other changes.
6+
-->
7+
8+
### Affected Documentation
9+
10+
Link to GitHub Issue:
11+
12+
Affected Documentation:
13+
14+
- [ ] README
15+
- [ ] Setup Instructions
16+
- [ ] API Documentation
17+
- [ ] Developer Guide
18+
- [ ] Contribution Guide
19+
- [ ] Other (please specify):
20+
21+
## How Has This Been Tested?
22+
23+
Please describe how the changes to documentation were reviewed. If applicable, include instructions on how to view or
24+
test the updated documentation.
25+
26+
- [ ] Documentation preview checked in markdown renderer
27+
- [ ] Links and images tested for correctness
28+
29+
<!--
30+
Test Configuration:
31+
- Viewing tool: (e.g., GitHub Preview, Markdown renderer)
32+
- Platform: (e.g., browser, OS)
33+
-->
34+
35+
## Checklist for Author
36+
37+
- [ ] The PR follows below contribution conventions
38+
- [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
39+
scope): issue_reference message
40+
- [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
41+
scope): issue_reference message
42+
- [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description]
43+
- [ ] My code follows the style guidelines of this project
44+
- [ ] I have performed a self-review of my documentation to reflect the code changes, spelling and is clearly accurate
45+
- [ ] I have tested the documentation for correctness and if required added evidences(e.g., links, images)
46+
- [ ] My changes generate no new warnings or errors
47+
- [ ] Checks for unused files
48+
- [ ] Checks for changes not related to this issue
49+
50+
## Additional notes for reviewer
51+
52+
<!-- Add any information that can be useful to the reviewer -->
53+
54+
## Checklist for Reviewer
55+
56+
- [ ] The PR follows contribution guidelines
57+
- [ ] Reviewed documentation for accuracy and rendering

‎.github/PULL_REQUEST_TEMPLATE/feature_pr_template.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## Description
2+
3+
<!--
4+
Please include a summary of the changes made to the documentation. Explain the motivation for the change and the impact on the users or developers who rely on this documentation.
5+
Please specify if this PR has dependency on any other changes.
6+
-->
7+
8+
### Type of feature request
9+
10+
Link to GitHub Issue:
11+
12+
Please add/delete options that are not relevant.
13+
14+
- [ ] App code
15+
- [ ] Testing
16+
- [ ] CI/CD pipeline
17+
- [ ] DevSecOps
18+
- [ ] Configuration
19+
20+
## How Has This Been Tested?
21+
22+
<!--
23+
Please describe the tests that you ran to verify your changes.
24+
25+
- Test case 1 (please describe)
26+
- Test case 2 (please describe)
27+
28+
Please attach relevant evidences supporting the test execution.
29+
-->
30+
31+
## Checklist for Author
32+
33+
- [ ] The PR follows below contribution conventions
34+
- [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
35+
scope): issue_reference message
36+
- [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
37+
scope): issue_reference message
38+
- [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description]
39+
- [ ] I have tested the enhancement thoroughly and attached test evidences confirming changes works as expected
40+
- [ ] I have updated the documentation to reflect enhancement (if applicable)
41+
- [ ] My changes generate no new warnings or errors and added tests that prove my feature PR is effective
42+
- [ ] Checks for unused files
43+
- [ ] Checks for changes not related to this issue
44+
45+
## Additional notes for reviewer
46+
47+
<!-- Add any information that can be useful to the reviewer -->
48+
49+
## Checklist for Reviewer
50+
51+
- [ ] The PR follows contribution guidelines
52+
- [ ] I have reviewed the author checklist
53+
- [ ] I have tested the changes locally are working as expected

‎.github/PULL_REQUEST_TEMPLATE/generic_pr_template.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## Description
2+
3+
<!--
4+
Please provide a summary of the changes made, the motivation for making the changes, and any context regarding how it impacts the functionality or users.
5+
Please specify if this PR has dependency on any other changes.
6+
-->
7+
8+
### Type of Change
9+
10+
Link to GitHub Issue:
11+
12+
## How has this been tested?
13+
14+
<!--
15+
Please describe the tests that you ran to verify your changes.
16+
17+
- Test case 1 (please describe)
18+
- Test case 2 (please describe)
19+
20+
Please attach relevant evidences supporting the test execution.
21+
-->
22+
23+
## Checklist for Author
24+
25+
- [ ] The PR follows below contribution conventions
26+
- [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
27+
scope): issue_reference message
28+
- [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
29+
scope): issue_reference message
30+
- [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description]
31+
- [ ] I have tested the changes thoroughly and attached test evidences confirming changes works as expected
32+
- [ ] I have updated the documentation to reflect changes (if applicable)
33+
- [ ] My changes generate no new warnings or errors
34+
- [ ] Checks for unused files
35+
- [ ] Checks for changes not related to this issue
36+
37+
## Additional notes for reviewer
38+
39+
<!-- Add any information that can be useful to the reviewer -->
40+
41+
## Checklist for Reviewer
42+
43+
- [ ] The PR follows contribution guidelines
44+
- [ ] I have reviewed the author checklist
45+
- [ ] I have tested the changes locally are working as expected

‎.github/PULL_REQUEST_TEMPLATE/security_vulnerability_pr_template.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## Description
2+
3+
<!--
4+
Please provide a summary of the security vulnerability being fixed, the motivation for fixing it, and any context regarding how it impacts the functionality or users.
5+
Please specify if this PR has dependency on any other changes.
6+
-->
7+
8+
### Type of Security Vulnerability
9+
10+
Link to GitHub Issue:
11+
12+
Please select or add the type of Security Vulnerability fixed.
13+
14+
- [ ] App Code (non-breaking change which fixes an issue)
15+
- [ ] App Code Dependency
16+
- [ ] Container Image vulnerability
17+
- [ ] IAC vulnerability
18+
19+
## How has this been tested?
20+
21+
<!--
22+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce the bug, and describe the expected behavior after the fix.
23+
24+
- Test case 1 (please describe)
25+
- Test case 2 (please describe)
26+
27+
Please attach relevant evidences supporting the test execution.
28+
-->
29+
30+
## Checklist for Author
31+
32+
- [ ] The PR follows below contribution conventions
33+
- [ ] PR title follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
34+
scope): issue_reference message
35+
- [ ] PR commits follows [conventional commits](https://docs.cocogitto.io/guide/commit.html) format commit_type(
36+
scope): issue_reference message
37+
- [ ] PR branch follows convention of format [commit_type]-[issue-reference]-[brief-description]
38+
- [ ] I have tested the security vulnerability thoroughly and attached test evidences confirming changes works as
39+
expected
40+
- [ ] I have updated the documentation to reflect bug fixes (if applicable)
41+
- [ ] My changes generate no new warnings or errors
42+
- [ ] Checks for unused files
43+
- [ ] Checks for changes not related to this issue
44+
45+
## Additional notes for reviewer
46+
47+
<!-- Add any information that can be useful to the reviewer -->
48+
49+
## Checklist for Reviewer
50+
51+
- [ ] The PR follows contribution guidelines
52+
- [ ] I have reviewed the author checklist
53+
- [ ] I have tested the changes locally are working as expected

‎.github/pull_request_template.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Instructions
2+
3+
Click the **Preview** tab and select a relevant PR template.
4+
5+
Please use generic template for other types of changes.
6+
7+
- [Feature](?expand=1&template=feature_pr_template.md)
8+
- [Bug](?expand=1&template=bug_pr_template.md)
9+
- [Document](?expand=1&template=document_pr_template.md)
10+
- [Security Vulnerability](?expand=1&template=security_vulnerability_pr_template.md)
11+
- [Generic](?expand=1&template=generic_pr_template.md)

0 commit comments

Comments
 (0)