From 3b0e0a87e77a120f3b18285ca223c33f83b8a5c7 Mon Sep 17 00:00:00 2001 From: Gaba Date: Tue, 22 Dec 2020 09:05:55 -0300 Subject: [PATCH 1/5] Adds issue creation templates for bugs, features, proposals and documentation. --- .gitlab/issue_templates/bug.md | 42 ++++++++++++++++++++++++ .gitlab/issue_templates/documentation.md | 35 ++++++++++++++++++++ .gitlab/issue_templates/feature.md | 15 +++++++++ .gitlab/issue_templates/proposal.md | 5 +++ 4 files changed, 97 insertions(+) create mode 100644 .gitlab/issue_templates/bug.md create mode 100644 .gitlab/issue_templates/documentation.md create mode 100644 .gitlab/issue_templates/feature.md create mode 100644 .gitlab/issue_templates/proposal.md diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md new file mode 100644 index 0000000000..d27dea552d --- /dev/null +++ b/.gitlab/issue_templates/bug.md @@ -0,0 +1,42 @@ + + +### Summary + + + +### Steps to reproduce: + +1. step 1 +2. step 2 +3. ... + +### What is the current bug behavior? + + + +### What is the expected behavior? + + + +### Environment + + + +- Version: e.g. 0.10, output of --version (without backslashes) +- Operating system: Debian GNU/Linux 9.1 (stretch), Windows 7, Ubuntu Xenial, etc +- Install method: distribution package, from source tarball, from git, etc +- etc... + +### Relevant logs and/or screenshots: + + + +### Possible fixes: + + + +/label ~bug diff --git a/.gitlab/issue_templates/documentation.md b/.gitlab/issue_templates/documentation.md new file mode 100644 index 0000000000..6f0d4b49b8 --- /dev/null +++ b/.gitlab/issue_templates/documentation.md @@ -0,0 +1,35 @@ + + +### Problem to solve + + + +* What feature(s) affected? +* What docs or doc section affected? Include links or paths. +* Is there a problem with a specific document, or a feature/process that's not addressed sufficiently in docs? +* Any other ideas or requests? + + +### Further details + + + +### Proposal + + + +### Who can address the issue + + + +### Other links/references + + + +/label ~documentation diff --git a/.gitlab/issue_templates/feature.md b/.gitlab/issue_templates/feature.md new file mode 100644 index 0000000000..f0c3f1bdfe --- /dev/null +++ b/.gitlab/issue_templates/feature.md @@ -0,0 +1,15 @@ + + +### Summary + + + +### What is the expected behavior? + + + + + +/label ~Feature diff --git a/.gitlab/issue_templates/proposal.md b/.gitlab/issue_templates/proposal.md new file mode 100644 index 0000000000..990ca70a0a --- /dev/null +++ b/.gitlab/issue_templates/proposal.md @@ -0,0 +1,5 @@ + + +### Proposal + + From cdc66380021dcec7f2276164c9df4aa57e62f87f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20F=C3=A6r=C3=B8y?= Date: Fri, 12 Feb 2021 20:36:17 +0000 Subject: [PATCH 2/5] Remove documentation issue template. I think the issues we get in here will be covered by either the bug or feature document. --- .gitlab/issue_templates/documentation.md | 35 ------------------------ 1 file changed, 35 deletions(-) delete mode 100644 .gitlab/issue_templates/documentation.md diff --git a/.gitlab/issue_templates/documentation.md b/.gitlab/issue_templates/documentation.md deleted file mode 100644 index 6f0d4b49b8..0000000000 --- a/.gitlab/issue_templates/documentation.md +++ /dev/null @@ -1,35 +0,0 @@ - - -### Problem to solve - - - -* What feature(s) affected? -* What docs or doc section affected? Include links or paths. -* Is there a problem with a specific document, or a feature/process that's not addressed sufficiently in docs? -* Any other ideas or requests? - - -### Further details - - - -### Proposal - - - -### Who can address the issue - - - -### Other links/references - - - -/label ~documentation From 003e237dfc604edb7833701f61e869b0ad3b19b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20F=C3=A6r=C3=B8y?= Date: Fri, 12 Feb 2021 20:38:21 +0000 Subject: [PATCH 3/5] Elaborate a few of the items from Gaba's initial templates. --- .gitlab/issue_templates/bug.md | 26 ++++++++------------------ .gitlab/issue_templates/feature.md | 6 ------ 2 files changed, 8 insertions(+), 24 deletions(-) diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md index d27dea552d..3702c1f0b6 100644 --- a/.gitlab/issue_templates/bug.md +++ b/.gitlab/issue_templates/bug.md @@ -1,16 +1,11 @@ - - ### Summary ### Steps to reproduce: -1. step 1 -2. step 2 -3. ... +1. Step 1 +2. ... ### What is the current bug behavior? @@ -22,21 +17,16 @@ ### Environment - +- Which version of Tor are you using? Run `tor --version` to get the version if you are unsure. +- Which operating system are you using? For example: Debian GNU/Linux 10.1, Windows 10, Ubuntu Xenial, FreeBSD 12.2, etc. +- Which installation method did you use? Distribution package (apt, pkg, homebrew), from source tarball, from Git, etc. -- Version: e.g. 0.10, output of --version (without backslashes) -- Operating system: Debian GNU/Linux 9.1 (stretch), Windows 7, Ubuntu Xenial, etc -- Install method: distribution package, from source tarball, from git, etc -- etc... - -### Relevant logs and/or screenshots: +### Relevant logs and/or screenshots -### Possible fixes: +### Possible fixes -/label ~bug +/label ~Bug diff --git a/.gitlab/issue_templates/feature.md b/.gitlab/issue_templates/feature.md index f0c3f1bdfe..62b2f8e944 100644 --- a/.gitlab/issue_templates/feature.md +++ b/.gitlab/issue_templates/feature.md @@ -1,7 +1,3 @@ - - ### Summary @@ -10,6 +6,4 @@ - - /label ~Feature From 22df6a3127fe4f55217186be068048905a24d14d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20F=C3=A6r=C3=B8y?= Date: Fri, 12 Feb 2021 20:39:28 +0000 Subject: [PATCH 4/5] Use titlecase for template filenames. --- .gitlab/issue_templates/{bug.md => Bug.md} | 0 .gitlab/issue_templates/{feature.md => Feature.md} | 0 .gitlab/issue_templates/{proposal.md => Proposal.md} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename .gitlab/issue_templates/{bug.md => Bug.md} (100%) rename .gitlab/issue_templates/{feature.md => Feature.md} (100%) rename .gitlab/issue_templates/{proposal.md => Proposal.md} (100%) diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/Bug.md similarity index 100% rename from .gitlab/issue_templates/bug.md rename to .gitlab/issue_templates/Bug.md diff --git a/.gitlab/issue_templates/feature.md b/.gitlab/issue_templates/Feature.md similarity index 100% rename from .gitlab/issue_templates/feature.md rename to .gitlab/issue_templates/Feature.md diff --git a/.gitlab/issue_templates/proposal.md b/.gitlab/issue_templates/Proposal.md similarity index 100% rename from .gitlab/issue_templates/proposal.md rename to .gitlab/issue_templates/Proposal.md From 7f32ae0eb55382b9ef59a36713887b7a8927b794 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20F=C3=A6r=C3=B8y?= Date: Fri, 12 Feb 2021 20:39:48 +0000 Subject: [PATCH 5/5] Remove Proposal.md. I don't think the Proposal.md fits well with the kind of tickets we see. Let's start with Features and Bug and expand upon it as we go. --- .gitlab/issue_templates/Proposal.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 .gitlab/issue_templates/Proposal.md diff --git a/.gitlab/issue_templates/Proposal.md b/.gitlab/issue_templates/Proposal.md deleted file mode 100644 index 990ca70a0a..0000000000 --- a/.gitlab/issue_templates/Proposal.md +++ /dev/null @@ -1,5 +0,0 @@ - - -### Proposal - -