diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..273acaf30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +# Describe the bug +A clear and concise description of what the bug is. + +# To reproduce +Steps to reproduce the behavior: +1. Use method '...' +2. Pass parameters '...' +3. See error + +# Expected behavior +A clear and concise description of what you expected to happen. + +# Screenshots / Videos +If applicable, add screenshots or videos to help explain your problem. + +# Environment (please complete the following information + - OS: [e.g. iOS] + - Python Version: [e.g. 3.8.12] + - SDK + SDK Version: [e.g. labelbox@3.70.0 / labelbox[data]@3.71.0] + - Python Environment [e.g. pip freeze > requirements.txt] + +# Additional context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..1e6813008 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +# Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +# Describe the solution you'd like +A clear and concise description of what you want to happen. + +# 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. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 000000000..0bc7d036a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,33 @@ +# Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Document change (fix typo or modifying any markdown files, code comments or anything in the examples folder only) + +## All Submissions + +- [ ] Have you followed the guidelines in our Contributing document? +- [ ] Have you provided a description? +- [ ] Are your changes properly formatted? + +## New Feature Submissions + +- [ ] Does your submission pass tests? +- [ ] Have you added thorough tests for your new feature? +- [ ] Have you commented your code, particularly in hard-to-understand areas? +- [ ] Have you added a Docstring? + +## Changes to Core Features + +- [ ] Have you written new tests for your core changes, as applicable? +- [ ] Have you successfully run tests with your changes locally? +- [ ] Have you updated any code comments, as applicable?