-
Notifications
You must be signed in to change notification settings - Fork 29
Fix/296: Added three template similar to pecan #329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Create a report to help us improve | ||
|
|
||
| --- | ||
|
|
||
| ### Bug Description | ||
|
|
||
| A clear and concise description of what the bug is. | ||
|
|
||
| In the format "When I do X, I expect Y but observe Z" | ||
|
|
||
| ### To Reproduce | ||
|
|
||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
||
| ## Expected behavior | ||
|
|
||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| ## Screenshots | ||
|
|
||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| ## SIPNET Version | ||
|
|
||
| - Version or Git SHA [e.g. 2.1.0 or abc1234] | ||
|
|
||
| ## Additional context | ||
|
|
||
| Add any other context about the problem here. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| name: Documentation Changes | ||
| about: Create a report to help us improve | ||
|
|
||
| --- | ||
|
|
||
| ### Document Change needed | ||
|
|
||
| A clear description of what changes are needed with the location of the error, or that needs to be fixed. | ||
|
|
||
| Example: | ||
| There is a broken URL link in the documentation. It is in the parameters documentation. The underlying file is `docs/parameters.md`. The correct link should be https://aws.amazon.com/. | ||
|
|
||
| ### Information for those wanting to make changes | ||
|
|
||
| Please refer to the documentation guidelines in `CONTRIBUTING.md` to learn how to make changes to the documentation. | ||
|
|
||
| All markdown files related to documentation are located within the main directory `docs/`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest an idea for this project | ||
|
|
||
| --- | ||
|
|
||
| ## Description | ||
|
|
||
| **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 [...] | ||
|
Comment on lines
+9
to
+10
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should be careful not to make this seem like a bug report. How about something like: ** A short summary of your requested feature** |
||
|
|
||
| ## 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! | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I love this, but it might be a little too preachy 😂 How about: |
||
|
|
||
| ## Alternatives Considered (Optional) | ||
|
|
||
| **Describe alternatives you've considered** | ||
| A clear and concise description of any alternative workflows or workarounds you are currently using. | ||
|
Comment on lines
+17
to
+20
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this section should be dropped? This is solution space stuff. |
||
|
|
||
| ## Additional Context | ||
|
|
||
| Add any other context or screenshots about the feature request here. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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