From f81e7f2235f6a5871ded8c3b8bc949633da98412 Mon Sep 17 00:00:00 2001 From: Elvis De Freitas Souza Date: Tue, 27 Aug 2024 18:53:46 -0300 Subject: [PATCH 1/5] new template proposal --- .github/ISSUE_TEMPLATE/feature-request.md | 45 +++++++++++++++++++---- 1 file changed, 38 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index abe491ce1..4f20a4c92 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,16 +7,47 @@ assignees: '' --- -## What is Happening +## Summary -What is the actual behavior and lacks which without that feature, and what's the fallback (if there is one) -while this feature is not implemented yet. +> A short description of what it is -## What is Expected +Example: -Please describe the wanted behavior with details of how it could work. +> Provide a solver which can solve from previously configured DNS records. +## Goals -## Changes (Optional) +> What is supposed to do in short. -Steps to implement the desired feature. +Example + +> A simple, static DNS server + +## Non-Goals + +> What people would think it is supposed to do, but it is not? + +Example +> * Not to implement a full and complex DNS server + +## Motivation + +> Why it's a feature to be considered? + +Example: + +> People can use DPS for static DNS entries instead of use /etc/hosts or something like. + +## Description + +> Explain the feature details and how it would work, usecases, examples, snippets of code, inputs and outputs, etc. + +Example + +> ### Storage +> +> DNS records will be stored at the existing DPS config file. +> +> ### DNS Records +> * It will have support to A, AAAA and CNAME entries. +> * Also, TTL by record will be supported From 054087cc4cc3a8bf253d041285afb3d73b590af5 Mon Sep 17 00:00:00 2001 From: Elvis De Freitas Souza Date: Wed, 28 Aug 2024 14:18:50 -0300 Subject: [PATCH 2/5] specifying what is required and what is not --- .github/ISSUE_TEMPLATE/feature-request.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 4f20a4c92..a710e4388 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -9,7 +9,7 @@ assignees: '' ## Summary -> A short description of what it is +> A short description of what it is. (Required) Example: @@ -17,7 +17,7 @@ Example: ## Goals -> What is supposed to do in short. +> What is supposed to do in short. (Optional) Example @@ -25,14 +25,14 @@ Example ## Non-Goals -> What people would think it is supposed to do, but it is not? +> What people would think it is supposed to do, but it is not? (Optional) Example > * Not to implement a full and complex DNS server ## Motivation -> Why it's a feature to be considered? +> Why it's a feature to be considered? (Required) Example: @@ -40,7 +40,8 @@ Example: ## Description -> Explain the feature details and how it would work, usecases, examples, snippets of code, inputs and outputs, etc. +> Explain the feature details and how it would work, usecases, examples, snippets of code, +> inputs and outputs, etc. (Required) Example From c85aaad82f56a0dd4a79b764140a06d301894f7d Mon Sep 17 00:00:00 2001 From: Elvis De Freitas Souza Date: Wed, 28 Aug 2024 14:22:18 -0300 Subject: [PATCH 3/5] adjusting labels and creating general content --- .../bug-unexpected-behavior-report.md | 4 +- .github/ISSUE_TEMPLATE/feature-request.md | 6 +-- .github/ISSUE_TEMPLATE/general.md | 54 +++++++++++++++++++ 3 files changed, 59 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/general.md diff --git a/.github/ISSUE_TEMPLATE/bug-unexpected-behavior-report.md b/.github/ISSUE_TEMPLATE/bug-unexpected-behavior-report.md index d6ce35257..d43197811 100644 --- a/.github/ISSUE_TEMPLATE/bug-unexpected-behavior-report.md +++ b/.github/ISSUE_TEMPLATE/bug-unexpected-behavior-report.md @@ -1,8 +1,8 @@ --- name: Bug/Unexpected Behavior Report about: Create a report to help DPS improve -title: '' -labels: '' +title: 'Bug: ' +labels: 'bug-report' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index a710e4388..4e19e3e37 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,8 +1,8 @@ --- name: Feature request -about: Suggest an idea for DPS project -title: '' -labels: '' +about: Suggest an idea to a new feature or enhancement for the DPS project +title: 'Feature Request: ' +labels: 'feature-request' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md new file mode 100644 index 000000000..eff927d9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.md @@ -0,0 +1,54 @@ +--- +name: Discussion +about: Any other content that doesn't fit in the other templates +title: '' +labels: 'discussion' +assignees: '' + +--- + +## Summary + +> A short description of what it is. (Required) + +Example: + +> Provide a solver which can solve from previously configured DNS records. + +## Goals + +> What is supposed to do in short. (Optional) + +Example + +> A simple, static DNS server + +## Non-Goals + +> What people would think it is supposed to do, but it is not? (Optional) + +Example +> * Not to implement a full and complex DNS server + +## Motivation + +> Why it's a feature to be considered? (Required) + +Example: + +> People can use DPS for static DNS entries instead of use /etc/hosts or something like. + +## Description + +> Explain the feature details and how it would work, usecases, examples, snippets of code, +> inputs and outputs, etc. (Required) + +Example + +> ### Storage +> +> DNS records will be stored at the existing DPS config file. +> +> ### DNS Records +> * It will have support to A, AAAA and CNAME entries. +> * Also, TTL by record will be supported From e4bfc4d99e96695e74ffec1ac35400856f4737e5 Mon Sep 17 00:00:00 2001 From: Elvis De Freitas Souza Date: Wed, 28 Aug 2024 14:34:42 -0300 Subject: [PATCH 4/5] unify summary and motivation --- .github/ISSUE_TEMPLATE/feature-request.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 4e19e3e37..9f8829d98 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,13 +7,14 @@ assignees: '' --- -## Summary +## Summary & Motivation -> A short description of what it is. (Required) +> A short description of what is it and why it's important to be considered. (Required) Example: > Provide a solver which can solve from previously configured DNS records. +> It's will be useful because people can use DPS for static DNS entries instead of use /etc/hosts or something like. ## Goals @@ -30,14 +31,6 @@ Example Example > * Not to implement a full and complex DNS server -## Motivation - -> Why it's a feature to be considered? (Required) - -Example: - -> People can use DPS for static DNS entries instead of use /etc/hosts or something like. - ## Description > Explain the feature details and how it would work, usecases, examples, snippets of code, From a75e37c5b78f0b68c2ee2eeeeba07559bcd54742 Mon Sep 17 00:00:00 2001 From: Elvis De Freitas Souza Date: Wed, 28 Aug 2024 14:36:36 -0300 Subject: [PATCH 5/5] empty content --- .github/ISSUE_TEMPLATE/general.md | 46 ------------------------------- 1 file changed, 46 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md index eff927d9c..296804d9a 100644 --- a/.github/ISSUE_TEMPLATE/general.md +++ b/.github/ISSUE_TEMPLATE/general.md @@ -6,49 +6,3 @@ labels: 'discussion' assignees: '' --- - -## Summary - -> A short description of what it is. (Required) - -Example: - -> Provide a solver which can solve from previously configured DNS records. - -## Goals - -> What is supposed to do in short. (Optional) - -Example - -> A simple, static DNS server - -## Non-Goals - -> What people would think it is supposed to do, but it is not? (Optional) - -Example -> * Not to implement a full and complex DNS server - -## Motivation - -> Why it's a feature to be considered? (Required) - -Example: - -> People can use DPS for static DNS entries instead of use /etc/hosts or something like. - -## Description - -> Explain the feature details and how it would work, usecases, examples, snippets of code, -> inputs and outputs, etc. (Required) - -Example - -> ### Storage -> -> DNS records will be stored at the existing DPS config file. -> -> ### DNS Records -> * It will have support to A, AAAA and CNAME entries. -> * Also, TTL by record will be supported