Skip to content

Commit 7cb9bc3

Browse files
authored
chore: add issue and PR templates (#2)
Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>
1 parent 4effe87 commit 7cb9bc3

4 files changed

Lines changed: 100 additions & 0 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior.
4+
title: "[Bug] - [Describe Issue]"
5+
labels: bug, triage
6+
assignees: ''
7+
---
8+
9+
### Description
10+
Please provide a clear and concise description of the issue you're experiencing. Be as detailed as possible about the problem.
11+
12+
### Steps to Reproduce
13+
Please list the steps required to reproduce the issue:
14+
15+
1. **Step 1**: [Describe the first step]
16+
2. **Step 2**: [Describe the second step]
17+
3. **Step 3**: [Describe the third step]
18+
4. [Continue adding steps if necessary]
19+
20+
### Expected Behavior
21+
What were you expecting to happen?
22+
23+
### Actual Behavior
24+
What actually happened? Please include any error messages, logs, or unexpected behavior you observed.
25+
26+
### Debug Information
27+
Attach the debug output here if possible.
28+
29+
### Environment Information
30+
To assist with troubleshooting, please provide the following information about your environment:
31+
32+
Operating System: (e.g., Ubuntu 20.04, macOS 11.2)
33+
34+
CPU architecture information (e.g., x86-64 (AMD64))
35+
36+
### Screenshots or Logs
37+
If applicable, please provide screenshots or logs that illustrate the bug.
38+
39+
### Additional Information
40+
Any other information that might be useful to identify or fix the bug. For example:
41+
42+
Any steps that worked around the issue
43+
44+
Specific configurations or files that may be relevant

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/jenstroeger/fullstack-webapp-template/discussions
5+
about: Please ask and answer questions here.
6+
- name: Security Reports
7+
url: https://github.com/jenstroeger/fullstack-webapp-template/blob/main/SECURITY.md
8+
about: Please report security vulnerabilities following the instructions.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement.
4+
title: "[Feature Request] - [Describe Feature]"
5+
labels: enhancement, feature
6+
assignees: ''
7+
8+
---
9+
10+
### Description
11+
Please provide a clear and concise description of the feature or enhancement you'd like to see in this project. Explain why it would be useful and how it could improve the tool.
12+
13+
### Proposed Feature
14+
What functionality or feature would you like to add to this project? Please describe it in detail.
15+
16+
### Use Case

.github/pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Summary
2+
<!-- Briefly summarize the purpose and scope of this PR. -->
3+
4+
## Type of change
5+
<!-- Go over following points. check them with an `x` if they do apply. Please delete options that are not relevant. -->
6+
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] This change requires a documentation update
11+
12+
## Description of changes
13+
<!-- Provide a detailed explanation of the changes made in this PR, why they were needed, and how they address the issue(s). -->
14+
15+
## Related issues
16+
<!-- List any related issue(s) this PR addresses, e.g., `Closes #123`, `Fixes #456`. -->
17+
18+
# How Has This Been Tested?
19+
<!-- Please describe the tests that you ran to verify your changes. -->
20+
21+
- [ ] Test A
22+
- [ ] Test B
23+
24+
## Checklist
25+
<!-- Go over following points. check them with an `x` if they do apply, (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once) -->
26+
27+
- [ ] I have reviewed the [contribution guide](../CONTRIBUTING.md).
28+
- [ ] My PR title and commits follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) convention.
29+
- [ ] My commits include the "Signed-off-by" line.
30+
- [ ] I have signed my commits following the instructions provided by [GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Note that we run [GitHub's commit verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) tool to check the commit signatures. A green `verified` label should appear next to **all** of your commits on GitHub.
31+
- [ ] I have updated the relevant documentation, if applicable.
32+
- [ ] I have tested my changes and verified they work as expected.

0 commit comments

Comments
 (0)