Skip to content

Commit fcf88f5

Browse files
committed
chore(issue_template): #348 update label and heading descriotion as markdown comment
1 parent 7af0c35 commit fcf88f5

File tree

4 files changed

+41
-30
lines changed

4 files changed

+41
-30
lines changed
Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,45 @@
11
---
22
name: "Bug Report"
33
about: "Report a bug or unexpected behavior in the Spring Boot microservice"
4-
title: "[bug(scope)] - [Short description of the issue]"
4+
title: "bug(scope) - Short description of the issue"
55
labels: "bug"
66
assignees: ""
77

88
---
99

1010
## Description
11-
A clear and concise description of what the bug is and how it manifests.
11+
<!-- A clear and concise description of what the bug is and how it manifests. -->
1212

1313
## Steps to Reproduce
14+
<!--
1415
1. Step 1
1516
2. Step 2
16-
3. Step 3
17+
3. Step 3
18+
-->
1719

1820
## Expected Behavior
19-
A clear description of what you expected to happen.
21+
<!-- A clear description of what you expected to happen. -->
2022

2123
## Actual Behavior
22-
A clear description of what actually happened.
24+
<!-- A clear description of what actually happened. -->
2325

2426
## Screenshots/Logs
25-
If applicable, please attach any screenshots, logs, or error messages that may help in reproducing the issue.
27+
<!-- If applicable, please attach any screenshots, logs, or error messages that may help in reproducing the issue. -->
2628

27-
### Impacted Application/Tools/Utility Version:
29+
## Impacted Application/Tools/Utility Version:
30+
31+
<!--
2832
- Version: [e.g. v1.0.0]
2933
- Spring Boot Version: [e.g. 2.5.4]
3034
- Cog version
3135
- gradle etc
36+
-->
3237

33-
### Environment:
38+
## Environment:
39+
<!--
3440
- OS: [e.g. Ubuntu 20.04]
35-
- Java Version: [e.g. OpenJDK 11]
41+
- Java Version: [e.g. OpenJDK 11]
42+
-->
3643

3744
## Additional Information
38-
Any other context or details that could help to resolve the issue (e.g., specific configurations, network setup, etc.).
45+
<!-- Any other context or details that could help to resolve the issue (e.g., specific configurations, network setup, etc.). -->
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
---
22
name: "Documentation Improvement"
33
about: "Suggest an improvement or correction to the project's documentation"
4-
title: "[docs(scope)] - [Short description of the documentation issue]"
4+
title: "docs(scope) - Short description of the documentation issue"
55
labels: "documentation"
66
assignees: ""
77

88
---
99

1010
## Description
11-
Describe the issue with the current documentation or areas where improvement is needed.
11+
<!-- Describe the issue with the current documentation or areas where improvement is needed. -->
1212

1313
## Suggested Changes
14-
Provide the suggested changes or additions to the documentation, including code snippets if applicable.
14+
<!-- Provide the suggested changes or additions to the documentation, including code snippets if applicable. -->
1515

16-
### Affected Documentation
16+
## Affected Documentation
1717
- [ ] README.md
1818
- [ ] API Documentation
1919
- [ ] Developer Guide
2020
- [ ] Setup Instructions
21+
- [ ] Contribution Guide
2122
- [ ] Other (please specify):
2223

2324
## Additional Information
24-
Any other context, examples, or links that may help improve the documentation.
25+
<!-- Any other context, examples, or links that may help improve the documentation.-->
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
11
---
22
name: "Feature Request"
33
about: "Request a new feature or enhancement for the spring-boot-microservice-best-practices repository"
4-
title: "[feat(scope)] - [short description of the Feature or enhancement]"
4+
title: "feat(scope)] - short description of the Feature or enhancement"
55
labels: "enhancement"
66
assignees: ""
77

88
---
99

1010
## Description
11+
<!--
1112
A clear and concise description of the feature you're requesting in this repository.
12-
13-
This can be anything from CI tool integration, Security feature (use Security-DevSecOps label), change in the code etc.
13+
This can be anything from CI tool integration, Security feature (use Security-DevSecOps label), change in the code etc.
14+
-->
1415

1516
## Use Case
16-
Describe the problem or use case you're trying to solve with this feature.
17+
<!-- Describe the problem or use case you're trying to solve with this feature. -->
1718

1819
## Proposed Solution
19-
A brief outline of how this feature could be implemented or how it would work in the application.
20+
<!-- A brief outline of how this feature could be implemented or how it would work in the application. -->
2021

2122
## Benefits
22-
Describe the benefits of this feature and why it should be prioritized.
23+
<!-- Describe the benefits of this feature and why it should be prioritized. -->
2324

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

2728
## Additional Information
28-
Any other details, mockups, or context that may help in understanding the request.
29+
<!-- Any other details, mockups, or context that may help in understanding the request. -->
Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
---
22
name: "Security Vulnerability Report"
33
about: "Report a potential security vulnerability in the Spring Boot microservice repository"
4-
title: "[security(scope)] - [Brief description of the vulnerability]"
5-
labels: "security"
4+
title: "security(scope) - Brief description of the vulnerability"
5+
labels: "vulnerabilities"
66
assignees: ""
77

88
---
99

1010
## Vulnerability Description
11-
A clear and detailed description of the potential security vulnerability. Include any identified weaknesses, attack vectors, or issues that could compromise the system.
11+
<!-- A clear and detailed description of the potential security vulnerability. Include any identified weaknesses, attack vectors, or issues that could compromise the system. -->
1212

1313
## Steps to Reproduce
14+
<!--
1415
1. Step 1
1516
2. Step 2
1617
3. Step 3
18+
-->
1719

1820
## Impact
19-
Describe the potential impact of the vulnerability. What could be compromised (e.g., data, system access, etc.)?
21+
<!-- Describe the potential impact of the vulnerability. What could be compromised (e.g., data, system access, etc.)? -->
2022

2123
## Suggested Mitigation or Fix
22-
If known, provide any suggestions for mitigating the vulnerability or fixing the issue.
24+
<!-- If known, provide any suggestions for mitigating the vulnerability or fixing the issue. -->
2325

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

2729
## Additional Information
28-
Any additional information, screenshots, or references to external sources (e.g., CVE links, research articles) that may assist in fixing or further analyzing the issue.
30+
<!-- Any additional information, screenshots, or references to external sources (e.g., CVE links, research articles) that may assist in fixing or further analyzing the issue. -->

0 commit comments

Comments
 (0)