Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit fe154d2

Browse files
committedApr 1, 2025·
chore(github): add issue templates
relates to STACKITTPR-138
1 parent 983bc64 commit fe154d2

File tree

3 files changed

+85
-0
lines changed

3 files changed

+85
-0
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug report
3+
about: Report a bug in the STACKIT Python SDK
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
12+
*Please add a clear and concise description of what the bug is.*
13+
14+
## Steps to reproduce
15+
<!-- Please add a small python example below which helps us reproduce the behavior. -->
16+
17+
```python
18+
# put your python example here
19+
# ...
20+
```
21+
22+
<!-- Please provide us with the steps to reproduce the behavior. -->
23+
24+
1. Run ...
25+
2. ...
26+
27+
## Actual behavior
28+
29+
*Please describe the current behavior of the STACKIT Python SDK. Don't forget to add detailed information like error messages.*
30+
31+
## Expected behavior
32+
33+
*Please describe the behavior which you would expect from the STACKIT Python SDK in that case.*
34+
35+
## Environment
36+
- OS:
37+
- Python version (see `python --version`): `3.X.X`
38+
- Version of the Python STACKIT SDK:
39+
40+
```
41+
# please run the following command to get the versions of the STACKIT Python SDK versions and add the output here in this code block
42+
43+
$ pip list | grep "stackit"
44+
```
45+
46+
**Additional information**
47+
48+
*Feel free to add any additional information here.*
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for the STACKIT Python SDK
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Problem description
11+
12+
*Is your feature request related to a problem? If so, please give us a clear and concise description of what the problem is.
13+
Example: I want to use the STACKIT Python SDK to implement [...] but I couldn't find a way to [...]*
14+
15+
## Proposed solution
16+
17+
*A clear and concise description of what you want to happen.*
18+
19+
<!-- Please add a Python example below which helps us understand your proposed solution. -->
20+
21+
```python
22+
# put your Python example here
23+
# ...
24+
```
25+
26+
## Alternative solutions (optional)
27+
28+
*A clear and concise description of any alternative solutions or features you've considered. (optional)*
29+
30+
## Additional information
31+
32+
*Feel free to add any additional information here.*
33+

‎.github/pull_request_template.md

+4
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ relates to #1234
1111

1212
- [ ] Issue was linked above
1313
- [ ] **No generated code was adjusted manually** (check [comments in file header](https://github.com/stackitcloud/stackit-sdk-python/blob/main/services/dns/src/stackit/dns/api_client.py#L10-L12))
14+
- [ ] Changelogs and versioning
15+
- [ ] Changelog in root directory was adjusted (see [here](https://github.com/stackitcloud/stackit-sdk-python/blob/608176ab8cdfa60a3cfb09da49de0b1aba5fea84/CHANGELOG.md))
16+
- [ ] Changelog of the service(s) was adjusted (see e.g. [here](https://github.com/stackitcloud/stackit-sdk-python/blob/608176ab8cdfa60a3cfb09da49de0b1aba5fea84/services/dns/CHANGELOG.md))
17+
- [ ] `pyproject.toml` of the service(s) was adjusted (see e.g. [here](https://github.com/stackitcloud/stackit-sdk-python/blob/608176ab8cdfa60a3cfb09da49de0b1aba5fea84/services/dns/pyproject.toml))
1418
- [ ] Examples were added / adjusted (see `examples/` directory)
1519
- [ ] Unit tests got implemented or updated
1620
- [x] Unit tests are passing: `make test` (will be checked by CI)

0 commit comments

Comments
 (0)
Please sign in to comment.