.github/ISSUE_TEMPLATE/issue_template.md

name: Bug Report about: Describe the bug in detail title: "[BUG] A short description of the bug" labels: '' assignees: ''

Note. Update the issue title to concisely describe the bug.

Describe the bug

Please provide a clear and concise description of what the bug is.

Provide a minimally reproducible example (reprex)

Provide a clear and concise description of the bug. It can be easily (but not necessarily) illustrated with a minimally reproducible example using the reprex package.

For tips on creating a reprex, see this StackOverflow link.

Expected behavior

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

R Session Information

Please report the output of either sessionInfo() or sessioninfo::session_info() here.

options(width = 120)
## insert session info here
# sessioninfo::session_info() ## provides GitHub, pandoc, and other details
# sessionInfo() ## base R function in case you don't want to install sessioninfo

Note. To avoid potential issues with version mixing and reproducibility, do not install packages from GitHub.

Additional Context

Provide some additional context for the bug report. You may include web links (e.g., from GitHub) to:

name: Feature Request about: Suggest an idea for this project title: "[FEATURE] Brief description of the feature" labels: 'enhancement' assignees: ''

Feature Description

Please provide a clear and concise description of the feature you're proposing.

Problem it Solves

Explain the problem that this feature addresses. Why is this feature necessary? How will it improve the project?

Alternatives Considered

Describe any alternative solutions or features you've considered. Why were they not chosen?

Additional Context

Provide any additional context about the feature request here. You may include:

Note: Please ensure your feature request is not already reported in the issues list before creating a new one.



bhklab/AnnotationGx documentation built on April 3, 2025, 4:27 p.m.