Skip to content

Commit

Permalink
docs: add issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jinhojang6 committed Sep 27, 2023
1 parent e4dde94 commit deb9a23
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

### Summary:
[Provide a brief summary of the issue.]

### Environment:
- Operating System:
- Browser (If applicable):
- Project Version:
- Additional relevant information:

### Steps to Reproduce:
1. [First step]
2. [Second step]
3. [And so on…]

### Expected Behavior:
[Provide a detailed description of the expected behavior.]

### Actual Behavior:
[Provide a detailed description of the actual behavior you are experiencing.]

### Screenshots (if applicable):
[Attach screenshots to help illustrate the issue.]

### Additional Information:
[Any additional information, configuration, or data that might be necessary to reproduce the issue.]

### Potential Solutions (if applicable):
[Optional: Provide any thoughts or ideas you might have on potential solutions to the issue.]
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

### Feature Request:
[Quick summary of the feature you would like to be added.]

### Why is this feature important?
[Explain why you think this feature would be beneficial.]

### How should it work?
[Briefly describe how you envision this feature working, or how you would like it to be implemented.]
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### Description:
[Provide a brief description of the changes in the pull request.]

### Related Issue(s):
[Link to the related Issue(s), if any.]

### Changes Included:
- [ ] Bugfix (a change that fixes an issue)
- [ ] New feature (a change that adds new functionality)
- [ ] Refactoring (a change that improves code quality and/or architecture)
- [ ] Other (explain below)

### Implementation Details:
[Explain any new decisions made during the implementation of the changes.]

### Testing:
[Describe how the changes have been tested.]

### Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published in downstream modules

0 comments on commit deb9a23

Please sign in to comment.