diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..fd74d82b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 + + +```python +# put your python example here +# ... +``` + + + +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.* diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..a9d05d28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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.* + + + +```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.* + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 28bc15e7..ab0fe2ad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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)