diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..746d95a2aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: File a report to help us reproduce and fix the problem +title: '' +labels: 'bug' +assignees: '' + +--- + +**PySDK Version** +- [ ] PySDK V2 (2.x) +- [ ] PySDK V3 (3.x) + +**Describe the bug** +A clear and concise description of what the bug is. + +**To reproduce** +A clear, step-by-step set of instructions to reproduce the bug. +The provided code need to be **complete** and **runnable**, if additional data is needed, please include them in the issue. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots or logs** +If applicable, add screenshots or logs to help explain your problem. + +**System information** +A description of your system. Please provide: +- **SageMaker Python SDK version**: +- **Framework name (eg. PyTorch) or algorithm (eg. KMeans)**: +- **Framework version**: +- **Python version**: +- **CPU or GPU**: +- **Custom Docker image (Y/N)**: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..5d43bfd67c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/aws/sagemaker-python-sdk/discussions + about: Use GitHub Discussions to ask and answer questions diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md new file mode 100644 index 0000000000..b64cd47873 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-request.md @@ -0,0 +1,17 @@ +--- +name: Documentation request +about: Request improved documentation +title: '' +labels: '' +assignees: '' + +--- + +**What did you find confusing? Please describe.** +A clear and concise description of what you found confusing. Ex. I tried to [...] but I didn't understand how to [...] + +**Describe how documentation can be improved** +A clear and concise description of where documentation was lacking and how it can be improved. + +**Additional context** +Add any other context or screenshots about the documentation request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..014e654f27 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest new functionality for this library +title: '' +labels: 'feature request' +assignees: '' + +--- + +**Describe the feature you'd like** +A clear and concise description of the functionality you want. + +**How would this feature be used? Please describe.** +A clear and concise description of the use case for this feature. Please provide an example, if possible. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here.