Skip to content

Commit

Permalink
chore: improve GitHub issue templates
Browse files Browse the repository at this point in the history
- Add default assignee and title prefix to bug reports
- Enhance feature request template with clearer structure
- Update templates to better align with MicrobiomeStat usage
  • Loading branch information
cafferychen777 committed Nov 4, 2024
1 parent e9bc33b commit a0dc48e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 47 deletions.
39 changes: 14 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,28 @@ assignees: ''
A clear and concise description of what the bug is.

**Reproducible Example**
Please provide a minimal reproducible example using `reprex::reprex()`. This will help us understand and fix the issue faster. If possible, include a small sample of your data or use example data to demonstrate the error.
Please provide a minimal reproducible example using one of our example datasets (e.g., peerj32.obj, subset_T2D.obj):

```r
# Your reproducible example here, preferably with a small data snippet or using example datasets
library(MicrobiomeStat)
data("peerj32.obj") # or your example data

# Your code that produces the error
```

**R Session Information**
Please provide your session information by running:
```r
sessionInfo()
```

**Expected Behavior**
A clear and concise description of what you expected to happen.

**Actual Behavior**
Describe what actually happened when you ran the code.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment Information:**

- Operating System:
- R Version:
- Package Version:
- Session Information (if applicable):

**Impact**
Describe if this bug affects other aspects of your work and its urgency.

**Attempted Solutions**
Describe any attempts you've made to solve the issue.

**Related Dependency Versions**
List the versions of any related dependencies, if applicable.

**Links to Related Issues or Discussions**
Provide links to related issues or discussions, if any.

**Additional Context**
Add any other context about the problem here, e.g., is this issue sporadic or consistent? Did it work in previous versions?
- Did this work in a previous version? If so, which version?
- Are you using any specific parameters or settings?
- Have you tried updating to the latest version of MicrobiomeStat?
34 changes: 12 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,21 @@ assignees: ''
---

**Feature Description**
A clear and concise description of what the feature is and what it aims to accomplish.
A clear description of the feature you'd like to see in MicrobiomeStat.

**Problem it Solves**
Describe the problem or challenge that this feature addresses.
**Use Case**
Describe the specific analysis scenario where this feature would be useful.

**Proposed Solution**
If you have an idea of how to implement this feature, please share it here.
**Example Data**
If possible, provide an example of input data and desired output:

**Alternatives Considered**
Describe any alternative solutions or features you have considered.
```r
# Example input data structure
# Example desired output
```

**Expected Impact**
Discuss the expected impact of this feature, including who will benefit from it and how.

**Priority and Urgency**
Provide your assessment of the priority and urgency of this feature.

**Potential Technical Challenges**
If you have knowledge about the technical aspects, describe any potential technical challenges or considerations in implementing this feature.

**Compatibility with Existing Features**
Discuss how this feature would fit with the existing system, including any potential compatibility issues.

**Desired Timeline**
If applicable, provide a desired timeline for when you would like to see this feature implemented.
**Alternative Solutions**
Have you considered any alternative approaches or existing functions?

**Additional Context**
Add any other context or screenshots about the feature request here.
Any other information that might help us understand your request better.

0 comments on commit a0dc48e

Please sign in to comment.