Fix/296: Added three template similar to pecan #329
Conversation
ayushman1210
requested review from
Alomir,
dlebauer,
mdietze and
mswilburn
as code owners
|
hey @Alomir please review this one when you have some free time |
Alomir
left a comment
Alomir
left a comment
There was a problem hiding this comment.
Great start, I have some proposed tweaks. Please feel free to wordsmith my suggestions!
| ## Use Cases and Requirements | ||
|
|
||
| **Describe the use cases and requirements** | ||
| Please focus on describing the problem and your requirements without going into the solution space. We believe in understanding requirements before design, and design before solution! |
There was a problem hiding this comment.
I love this, but it might be a little too preachy 😂
How about:
Please focus on describing the problem and your requirements without going into the solution space; this will help us design the best solution for this request.
| **Is your feature request related to a problem? Please describe.** | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
There was a problem hiding this comment.
We should be careful not to make this seem like a bug report. How about something like:
** A short summary of your requested feature**
Please describe the problem you are trying to solve, or the functionality you would like to see added.
| ## Alternatives Considered (Optional) | ||
|
|
||
| **Describe alternatives you've considered** | ||
| A clear and concise description of any alternative workflows or workarounds you are currently using. |
There was a problem hiding this comment.
I think this section should be dropped? This is solution space stuff.
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error |
There was a problem hiding this comment.
This is pretty gui-centric, which is often good but not here. Perhaps:
Include all relevant information to reproduce the error, if possible, including:
sipnetcommand run, with all command line options- input files used that show the problem
- output files from the above
|
Moving this to draft for now. Please move it back when it's ready! |
2 participants
Under the
.github/Issue_Template/directoryI have added three files
I fetched the templates that the pecan project uses and created them
FIX:#296