From 372fdcc679b9a7087f1538d905457a08bdd9ec45 Mon Sep 17 00:00:00 2001 From: Adrian Chang <601268+adrian-chang@users.noreply.github.com> Date: Wed, 3 Apr 2024 21:48:16 -0700 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..dd84ea782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**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..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**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. From e480b4dd5e325cc8ebefa2b71dc9c8c4f709702b Mon Sep 17 00:00:00 2001 From: Gabefire <33893811+Gabefire@users.noreply.github.com> Date: Fri, 24 May 2024 17:53:02 -0500 Subject: [PATCH 2/3] added basic pr request template --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++++-------------- .github/ISSUE_TEMPLATE/feature_request.md | 19 +++-------- .../pull_request_template.md | 32 ++++++++++++++++++ 3 files changed, 46 insertions(+), 38 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea782..9fe9b6ce7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,23 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** +# Describe the bug A clear and concise description of what the bug is. -**To Reproduce** +# To reproduce Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +# Expected behavior A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +# Screenshots / Videos +If applicable, add screenshots or videos to help explain your problem. -**Desktop (please complete the following information):** +# Environment (please complete the following information - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + - Python Version: [e.g. 3.8.12] + - SDK + SDK Version: [e.g. labelbox@3.70.0 / labelbox[data]@3.71.0] -**Additional context** +# 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 index bbcbbe7d6..1e6813008 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,11 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** +# 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** +# Describe the solution you'd like A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +# 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. +# 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..118a4e55f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,32 @@ +# 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? + +## 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? From ae3de0f24922193a46655530965461f3db4453b9 Mon Sep 17 00:00:00 2001 From: Adrian Chang Date: Wed, 29 May 2024 15:07:20 -0700 Subject: [PATCH 3/3] Updated forms --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9fe9b6ce7..273acaf30 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,10 +3,9 @@ A clear and concise description of what the bug is. # To reproduce Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Use method '...' +2. Pass parameters '...' +3. See error # Expected behavior A clear and concise description of what you expected to happen. @@ -18,6 +17,7 @@ If applicable, add screenshots or videos to help explain your problem. - 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/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 118a4e55f..0bc7d036a 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -24,6 +24,7 @@ Please delete options that are not relevant. - [ ] 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