Skip to content

chore(github): add issue templates #811

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

Merged
merged 1 commit into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Bug report
about: Report a bug in the STACKIT Python SDK
title: ''
labels: bug
assignees: ''

---

## Description

*Please add a clear and concise description of what the bug is.*

## Steps to reproduce
<!-- Please add a small python example below which helps us reproduce the behavior. -->

```python
# put your python example here
# ...
```

<!-- Please provide us with the steps to reproduce the behavior. -->

1. Run ...
2. ...

## Actual behavior

*Please describe the current behavior of the STACKIT Python SDK. Don't forget to add detailed information like error messages.*

## Expected behavior

*Please describe the behavior which you would expect from the STACKIT Python SDK in that case.*

## Environment
- OS:
- Python version (see `python --version`): `3.X.X`
- Version of the Python STACKIT SDK:

```
# please run the following command to get the versions of the STACKIT Python SDK versions and add the output here in this code block

$ pip list | grep "stackit"
```

**Additional information**

*Feel free to add any additional information here.*
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature request
about: Suggest an idea for the STACKIT Python SDK
title: ''
labels: enhancement
assignees: ''

---

## Problem description

*Is your feature request related to a problem? If so, please give us a clear and concise description of what the problem is.
Example: I want to use the STACKIT Python SDK to implement [...] but I couldn't find a way to [...]*

## Proposed solution

*A clear and concise description of what you want to happen.*

<!-- Please add a Python example below which helps us understand your proposed solution. -->

```python
# put your Python example here
# ...
```

## Alternative solutions (optional)

*A clear and concise description of any alternative solutions or features you've considered. (optional)*

## Additional information

*Feel free to add any additional information here.*

4 changes: 4 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ relates to #1234

- [ ] Issue was linked above
- [ ] **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))
- [ ] Changelogs and versioning
- [ ] Changelog in root directory was adjusted (see [here](https://github.com/stackitcloud/stackit-sdk-python/blob/608176ab8cdfa60a3cfb09da49de0b1aba5fea84/CHANGELOG.md))
- [ ] Changelog of the service(s) was adjusted (see e.g. [here](https://github.com/stackitcloud/stackit-sdk-python/blob/608176ab8cdfa60a3cfb09da49de0b1aba5fea84/services/dns/CHANGELOG.md))
- [ ] `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))
- [ ] Examples were added / adjusted (see `examples/` directory)
- [ ] Unit tests got implemented or updated
- [x] Unit tests are passing: `make test` (will be checked by CI)
Expand Down
Loading