-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #451 from fermiPy/issue_templates
Adding issue templates
- Loading branch information
Showing
4 changed files
with
82 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: "\U0001F41B Bug Report" | ||
about: "If something isn't working as expected \U0001F914." | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. What data are you using and how was it obtained? | ||
|
||
*NOTE:* This is for fermipy bug reports and not for questions about data analysis or issues with fermitools. | ||
|
||
**To Reproduce** | ||
|
||
Please provide enough information for someone else to reporoduce this bug. That means e.g. a script + (links to) necessary files + any command line options, or an ipython notebook or something similar. | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Log files** | ||
Add log files or copy & paste the entire terminal output. | ||
|
||
**Environment (please complete the following information):** | ||
- OS: (e.g. MacOS Monterey version 12.3.1) | ||
- Output of `uname -a` | ||
- fermipy, fermitools, and fermitools-data versions (e.g. fermipy 1.0.1, fermitools 2.0.8) | ||
|
||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Fermitools error reporting | ||
url: https://github.com/fermi-lat/Fermitools-conda/wiki/Error-Reporting | ||
about: Please see here for issues with the fermitools. | ||
- name: Fermi help desk | ||
url: mailto:fermihelp@milkyway.gsfc.nasa.gov | ||
about: Ask questions about the fermitools or general fermi data analysis | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: "\U0001F52D Data Analysis Question" | ||
about: "I am trying to analyze some data with fermipy and I am stuck!" | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Data Analysis Question | ||
|
||
**How do I...** | ||
|
||
Not sure if a certain command exists in fermipy or how to use it? Looking for examples or best practices? Ask here! | ||
|
||
**To reproduce** | ||
Please let us know which data file, instrument response function etc. you are using, and include your model(s) and analysis script. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: "\U0001F680 Feature Request" | ||
about: "I have a suggestion (and may want to implement it \U0001F642)!" | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Feature Request | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I have an issue when [...]. Add links to existing issues using `#<issue number>` | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. Add any considered drawbacks. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Teachability, Documentation, Adoption, Migration Strategy** | ||
If you can, explain how users will be able to use this and possibly write out a version the docs. | ||
Maybe a screenshot or design? |