Skip to content

Commit 3774bcc

Browse files
chore: add issue templates (#1105)
* chore: add issue templates These are the auto-generated templates for feature requests/bug reports * Revise bug report template structure and content * Create pull request template * Update feature request template --------- Co-authored-by: isc-dchui <dchui@intersystems.com>
1 parent 4fa6b26 commit 3774bcc

3 files changed

Lines changed: 69 additions & 0 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: 'bug'
5+
6+
---
7+
8+
## Describe the bug
9+
A clear and concise description of what the bug is.
10+
11+
## To Reproduce
12+
Steps to reproduce the behavior:
13+
1. Run IPM command '...'
14+
2. Run another IPM command '...'
15+
3. See error
16+
17+
## Expected behavior
18+
A clear and concise description of what you expected to happen.
19+
20+
## Screenshots
21+
If applicable, add screenshots to help explain your problem.
22+
23+
## System information (please complete the following information):
24+
- IPM version: [e.g. 0.10.6]
25+
- IRIS version: [e.g. output of $zversion]
26+
- OS: [e.g. Unix, Windows]
27+
- Docker or local:
28+
29+
## Additional context
30+
Add any other context about the problem here.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: 'enhancement'
5+
6+
---
7+
8+
## Link to the discussion thread
9+
Have you started a discussion thread about this feature request? If not, do that first.
10+
<!-- If you do not yet have approval from IPM's maintainers, add the "Needs Spec" label to this issue. -->
11+
12+
## Describe the problem
13+
A clear and concise description of what the problem is.
14+
15+
## Describe the solution
16+
A clear and concise description of what you want to happen.
17+
18+
## Describe alternatives
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
## Additional context
22+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Description
2+
- Link the issue using the [magic closing words](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue).
3+
- Provide a summary of the change and how it addresses the issue (e.g. if it is a bug, explain the root cause of the bug and how this change fixes it).
4+
- Include any other necessary context, especially if any section warrants special reviewer attention.
5+
6+
## Testing
7+
How has this change been tested? Have you added unit or integration tests as appropriate?
8+
9+
## Checklist
10+
<!-- You can select a checkbox by changing "[ ]" to "[x]" -->
11+
- [ ] This branch has the latest changes from the `main` branch rebased or merged.
12+
- [ ] Changelog entry added.
13+
- [ ] Unit (`zpm test -only`) and integration tests (`zpm verify -only`) pass.
14+
- [ ] Style matches the style guide in the [contributing guide](https://github.com/intersystems/ipm/blob/main/CONTRIBUTING.md#style-guide).
15+
- [ ] Documentation has been/will be updated
16+
- Source controlled docs, e.g. README.md, should be included in this PR and Wiki changes should be made after this PR is merged (add an extra issue for this if needed)
17+
- [ ] Pull request correctly renders in the "Preview" tab.

0 commit comments

Comments
 (0)