From 8e33f2caf50d5db750d1f2a76a7b1b28f6a2b8be Mon Sep 17 00:00:00 2001 From: Matt Love Date: Mon, 24 Jun 2019 13:57:50 -0700 Subject: [PATCH 1/5] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 46 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ 2 files changed, 66 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 0000000..c17c43b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +## Information + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +## Environment + +### Back End +**Server:** + - OS: [e.g. Ubuntu, CentOS] + - Python Version: + - Reverse Proxy: [e.g. NGINX, Caddy] + - Redis Version: + +### Front End +**Desktop:** + - OS: [e.g. Windows, macOS, Linux] + - Browser [e.g. Chrome, Safari, etc.] + - Version [e.g. Windows 10, macOS 10.14, Ubuntu Linux 18.04] + +**Smartphone: (if applicable):** + - 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 0000000..ea076d5 --- /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: enhancement +assignees: '' + +--- + +**A little about you.** +Describe your use case for hyperglass, the environment on which it runs, the predominant network device type, and any other relevant details. + +**Is your feature request related to a problem? Please describe.** +If yes, a clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here. From 0ea42ac68d3dfb01d566c2c6f19a6b4deeb6fa59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Skyler=20M=C3=A4ntysaari?= Date: Fri, 3 Jul 2020 03:10:01 +0300 Subject: [PATCH 2/5] Issue Templates: Added issue templates back and updated them. --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ++++++++++++++++++---------- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/PULL_REQUEST_TEMPLATE.md | 23 ++++++++++++++++-- 3 files changed, 45 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c17c43b..77456b1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,25 +7,33 @@ assignees: '' --- -## Information + -**Describe the bug** -A clear and concise description of what the bug is. +#### Expected behavior + -**To Reproduce** -Steps to reproduce the behavior. +#### Current Behavior + -**Expected behavior** -A clear and concise description of what you expected to happen. +#### Possible Solution + -**Screenshots** -If applicable, add screenshots to help explain your problem. +#### Steps to Reproduce + + +1. +2. +3. +4. -## Environment +## Context (Environment) + + ### Back End **Server:** - OS: [e.g. Ubuntu, CentOS] + - Hyperglass Version: [e.g 1.0.0] - Python Version: - Reverse Proxy: [e.g. NGINX, Caddy] - Redis Version: @@ -42,5 +50,8 @@ If applicable, add screenshots to help explain your problem. - Browser [e.g. stock browser, safari] - Version [e.g. 22] -**Additional context** -Add any other context about the problem here. +## Screenshots + + +## Possible Implementation + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a49eab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d9182b5..49ddca5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,22 @@ -<-- Thank you for your interest in contributing to hyperglass. The contribution policy requires that a feature request or bug must be opened prior to a pull request being reviewed. Please list the related feature request or bug below: --> + -### Fixes: +## Description + + +## Related Issue + + + + + + +## Motivation and Context + + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): From e61131a87b15bafd149e6ce6eec89d82111545d0 Mon Sep 17 00:00:00 2001 From: Matt Love Date: Sun, 5 Jul 2020 17:58:16 -0700 Subject: [PATCH 3/5] Update and rename bug_report.md to 2-bug-report.md Made some structural edits, mainly stealing from [httpx's general structure/comments](https://github.com/encode/httpx/tree/master/.github/ISSUE_TEMPLATE). --- .github/ISSUE_TEMPLATE/2-bug-report.md | 51 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 57 -------------------------- 2 files changed, 51 insertions(+), 57 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/2-bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.md b/.github/ISSUE_TEMPLATE/2-bug-report.md new file mode 100644 index 0000000..e49015b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.md @@ -0,0 +1,51 @@ +--- +name: Bug Report +about: Report a problem or unexpected behavior +labels: bug +assignees: checktheroads +--- + + + +# Bug Description + + +# Expected behavior + + +# Steps to Reproduce + + +## Local Configurations + + +``` + +``` + +## Logs + + +``` + +``` + +# Possible Solution + + +# Environment + +## Server + - OS: + - Python Version: + - hyperglass Version: + +## Client + - OS & Version: + - Browser: + +### Smartphone Details (if applicable) + - Device: + - OS: + - Browser: + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 77456b1..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - - - -#### Expected behavior - - -#### Current Behavior - - -#### Possible Solution - - -#### Steps to Reproduce - - -1. -2. -3. -4. - -## Context (Environment) - - - -### Back End -**Server:** - - OS: [e.g. Ubuntu, CentOS] - - Hyperglass Version: [e.g 1.0.0] - - Python Version: - - Reverse Proxy: [e.g. NGINX, Caddy] - - Redis Version: - -### Front End -**Desktop:** - - OS: [e.g. Windows, macOS, Linux] - - Browser [e.g. Chrome, Safari, etc.] - - Version [e.g. Windows 10, macOS 10.14, Ubuntu Linux 18.04] - -**Smartphone: (if applicable):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -## Screenshots - - -## Possible Implementation - \ No newline at end of file From b1c24b251a2cd465a11480b1cefd7e0199ab9bc0 Mon Sep 17 00:00:00 2001 From: Matt Love Date: Sun, 5 Jul 2020 18:07:13 -0700 Subject: [PATCH 4/5] Update and rename feature_request.md to 1-feature-request.md --- .github/ISSUE_TEMPLATE/1-feature-request.md | 26 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---------------- 2 files changed, 26 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.md b/.github/ISSUE_TEMPLATE/1-feature-request.md new file mode 100644 index 0000000..44226d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-request.md @@ -0,0 +1,26 @@ +--- +name: Feature Request +about: Suggest an idea for this project +labels: enhancement +assignees: checktheroads +--- + + + +# Feature Description + + +### Is your feature request related to a problem? Please describe. + + +# Environment & Use Case + + +# Additional Context + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index ea076d5..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**A little about you.** -Describe your use case for hyperglass, the environment on which it runs, the predominant network device type, and any other relevant details. - -**Is your feature request related to a problem? Please describe.** -If yes, a clear and concise description of what the problem is. - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Additional context** -Add any other context or screenshots about the feature request here. From 2b43c297344b61d0ab53901b1d9149d2253351dc Mon Sep 17 00:00:00 2001 From: Matt Love Date: Sun, 5 Jul 2020 18:15:21 -0700 Subject: [PATCH 5/5] Update and rename PULL_REQUEST_TEMPLATE.md to pull_request_template.md --- .github/PULL_REQUEST_TEMPLATE.md | 22 ---------------------- .github/pull_request_template.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 22 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 49ddca5..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,22 +0,0 @@ - - -## Description - - -## Related Issue - - - - - - -## Motivation and Context - - - -## How Has This Been Tested? - - - - -## Screenshots (if appropriate): diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..748a1c7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ + + + + +# Description + + +# Related Issues + + +# Motivation and Context + + +# Tests +