Skip to content

Commit 0dfe66a

Browse files
committed
general: add some more templates
1 parent f5e118d commit 0dfe66a

File tree

4 files changed

+133
-0
lines changed

4 files changed

+133
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Opentrons/py

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax
2+
name: Bug Report
3+
description: File a bug
4+
title: 'bug: '
5+
labels: [bug]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for taking the time to file a bug!
11+
12+
- type: textarea
13+
attributes:
14+
label: Overview
15+
description: |
16+
Use this section to describe the bug at a high level.
17+
Please include any issues you can find that may be related.
18+
validations:
19+
required: true
20+
- type: dropdown
21+
attributes:
22+
label: Plugin
23+
description: Which package is this about?
24+
multiple: false
25+
options:
26+
- general
27+
- type: textarea
28+
attributes:
29+
label: Environment
30+
description: What environment (Python version, OS, hatchling version, etc) are you running the plugin on?
31+
- type: textarea
32+
attributes:
33+
label: Steps to reproduce
34+
description: |
35+
List precise steps to reproduce the bug.
36+
Please include screenshots, videos, and/or logs if possible.
37+
38+
Tip: You can attach files by clicking this area to highlight it and then dragging files in.
39+
validations:
40+
required: false
41+
- type: textarea
42+
attributes:
43+
label: Current behavior
44+
description: Describe how the software currently behaves and how that differs from how you think the software should behave.
45+
validations:
46+
required: false
47+
- type: textarea
48+
attributes:
49+
label: Expected behavior
50+
description: |
51+
Describe how you think the software should behave.
52+
validations:
53+
required: false
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax
2+
name: Feature request
3+
description: Suggest a new feature
4+
title: 'feat: '
5+
labels: [feature-request]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Thanks for taking the time to file a feature request!
11+
12+
- type: textarea
13+
attributes:
14+
label: Overview
15+
description: |
16+
Use this section to describe your idea at a high level.
17+
Please include some context about why you want this feature.
18+
19+
- What would this feature allow you to accomplish?
20+
- Are there any workarounds you use to partially achieve your goal?
21+
- Are there any GitHub issues you could find that may be related?
22+
validations:
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: Plugin
27+
description: Which package is this about?
28+
multiple: false
29+
options:
30+
- general
31+
- type: textarea
32+
attributes:
33+
label: Implementation details
34+
description: |
35+
List any implementation steps, specs, links to docs, or files here.
36+
37+
Tip: You can attach files by clicking this area to highlight it and then dragging files in.
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Design
43+
description: |
44+
Attach or link images and designs.
45+
46+
Tip: You can attach files by clicking this area to highlight it and then dragging files in.
47+
validations:
48+
required: false
49+
- type: textarea
50+
attributes:
51+
label: Acceptance criteria
52+
description: |
53+
A checklist of requirements and/or testing steps that must be complete before this feature is considered complete.
54+
This can also be used as a testing plan for associated PRs.
55+
validations:
56+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
Thanks for taking the time to open a pull request!
3+
To ensure your code is reviewed quickly and thoroughly, please fill out the sections below to the best of your ability!
4+
-->
5+
6+
# Overview
7+
8+
<!--
9+
Use this section to describe your pull-request at a high level. If the PR addresses any open issues, please tag the issues here.
10+
-->
11+
12+
# Test Plan
13+
14+
<!--
15+
Use this section to describe the steps that you took to test your Pull Request.
16+
If you did not perform any testing provide justification why.
17+
-->
18+
19+
# Review requests
20+
21+
<!--
22+
Describe any requests for your reviewers here.
23+
-->

0 commit comments

Comments
 (0)