Skip to content

Commit 5922411

Browse files
committed
Add issue and PR templates
1 parent dacbf65 commit 5922411

3 files changed

Lines changed: 118 additions & 0 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug Report
2+
description: Something's not working right in python-libjuju? Use this template.
3+
title: "[Bug]: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for pointing out this issue. Please provide info below so we could diagnose and fix it fast.
10+
- type: textarea
11+
id: Description
12+
attributes:
13+
label: Description
14+
description: "Please describe the bug for us: "
15+
placeholder: ex. "Client facade used to work for everything you need! Now I'm getting this error:"
16+
17+
- type: dropdown
18+
id: Urgency
19+
attributes:
20+
label: Urgency
21+
description: How urgent is this issue for you?
22+
options:
23+
- Casually reporting
24+
- Annoying bug in our test suite
25+
- Blocker for our release
26+
- Client presentation, help now please!
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: Libjuju-Version
32+
attributes:
33+
label: Python-libjuju version
34+
description: What version of python-libjuju exhibits this issue?
35+
placeholder: ex. edge, 2.9.10, 3.0.0
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: Juju-Version
41+
attributes:
42+
label: Juju version
43+
description: What version of Juju are we running against?
44+
placeholder: ex. edge, 2.9.33, 3.0-beta3, 3.0-rc1-798b0ef
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: info
50+
attributes:
51+
label: "Reproduce / Test"
52+
description: "Please add a valid Python code to reproduce the bug. This will be used as a test for QAing later on."
53+
render: python
54+
validations:
55+
required: true
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Feature Request
2+
description: You want something to be added to python-libjuju? Proceed with this one.
3+
title: "[Feature]: "
4+
labels: [wishlisted]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting this. Please provide info below so we can quickly add it to the python-libjuju.
10+
- type: textarea
11+
id: Description
12+
attributes:
13+
label: Description
14+
description: "Please describe what you want to see: "
15+
placeholder: ex. "It would be cool if python-libjuju was just a thin wrapper around Juju API!"
16+
17+
- type: dropdown
18+
id: Urgency
19+
attributes:
20+
label: Urgency
21+
description: How soon do you need to see this in python-libjuju?
22+
options:
23+
- Casually wishlisting
24+
- It would save from a weird workaround
25+
- Need this really badly for test suite
26+
- Client presentation, add it now, please!
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: info
32+
attributes:
33+
label: "Code I'd Like to Run"
34+
description: "Please provide valid Python code that you'd like to be able to run with this new feature: "
35+
render: python
36+
validations:
37+
required: true

.github/pull_request_template.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#### Description
2+
3+
*\<Please add why this change is needed and what it does.\>*
4+
5+
*\<Fixes: \>*
6+
7+
8+
#### QA Steps
9+
10+
*\<Commands/tests/steps to run to verify that the change works:\>*
11+
12+
```
13+
tox -e py3 -- tests/unit/...
14+
```
15+
16+
```
17+
tox -e integration -- tests/integration/...
18+
```
19+
20+
All CI tests need to pass.
21+
22+
*\<Please note that most likely an additional test will be required for any change that's not a one liner to land.\>*
23+
24+
#### Notes & Discussion
25+
26+
*Additional notes for the reviewers if needed. Please delete section if not applicable.*

0 commit comments

Comments
 (0)