Skip to content

Commit 0db767a

Browse files
committed
feat: GH templates
1 parent 83298b4 commit 0db767a

3 files changed

Lines changed: 78 additions & 0 deletions

File tree

.github/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] Bug name"
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## Bug Report
10+
11+
### Description
12+
[Provide a clear and concise description of the bug. What behavior did you observe that you believe to be a bug?]
13+
14+
### Reproducible Example
15+
[Include a minimal, complete, and verifiable example that demonstrates the bug. This could be a code snippet, dataset, or specific steps to reproduce the issue.]
16+
17+
### Expected Behavior
18+
[Describe what you expected to happen when you encountered the bug.]
19+
20+
### Actual Behavior
21+
[Explain what actually happened when you encountered the bug.]
22+
23+
### Environment
24+
- R Version: [e.g., 4.0.3]
25+
- Package Version: [e.g., 1.2.3]
26+
- Operating System: [e.g., Windows 10, macOS 11.1]
27+
28+
### Additional Context
29+
[Add any additional context, information, or examples that can help in understanding and reproducing the bug.]
30+
31+
### Impact
32+
[Explain the impact or consequences of this bug. How does it affect the package's functionality or the user experience?]
33+
34+
### Related Issues
35+
[Are there any related issues, pull requests, or discussions that are relevant to this bug report?]

.github/feature_request.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEAT] Feature name"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Request
11+
12+
### Description
13+
[Provide a clear and concise description of the feature you are requesting. What problem does it aim to solve?]
14+
15+
### Proposed Solution
16+
[Outline a proposed solution or approach for implementing the feature. How do you envision the feature working?]
17+
18+
### Use Case
19+
[Describe a specific use case or scenario where this feature would be beneficial or necessary.]
20+
21+
### Additional Context
22+
[Add any additional context, information, or examples that support or clarify the feature request.]
23+
24+
### Impact
25+
[Explain the potential impact of this feature on the package and its users. How would it improve the package or benefit the user community?]
26+
27+
### Related Issues
28+
[Are there any related issues or pull requests that are relevant to this feature request?]

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
(Summary of made changes with explanation of what and why)
3+
4+
## Changes Made
5+
- ...
6+
7+
## Testing
8+
- ...
9+
10+
## Checklist
11+
- [ ] Code changes have been tested
12+
- [ ] Documentation has been updated, if applicable
13+
- [ ] All automated tests pass
14+
- [ ] Coding style and naming conventions have been followed
15+
- [ ] The PR is ready for review and merge

0 commit comments

Comments
 (0)