From fa2ec7fb1803a2b63e00157b347229a8cd59552c Mon Sep 17 00:00:00 2001 From: Roey Darwish Dror Date: Wed, 19 Feb 2020 20:56:54 +0200 Subject: [PATCH] Issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 21 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..4f138686 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,21 @@ +--- +name: Bug report +about: Topgrade might be misbehaving +labels: is:bug +--- + +**What did you expect to happen?** +... + + +**What actually happened?** +... + + +**Additional details:** +- Which operating system or Linux distribution are you using? +- How did you install Topgrade? + +
+Paste the output of `topgrade -v`
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..5e14d0a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Can you please supprt...? +labels: is:new +--- + +**Describe the feature** +***Are you suggesting a new step?*** +- Which tool is this about? Where is its repository? +- Which operating systems are supported by this tool? +- What should Topgrade do to figure out if the tool needs to be invoked? +- Which exact commands should Topgrade run? + +***Are you suggesting some general feature?*** +Go ahead and tell me + +**System information** +
+Place the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..8d16c858 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +## Standards checklist: + +- [ ] The PR title is descriptive. +- [ ] The code compiles +- [ ] The code passes rustfmt +- [ ] The code passes clippy +- [ ] The code passes tests +- [ ] *Optional:* I have tested the code myself + - [ ] I also tested that Topgrade skips the step where needed + +If you developed a feature or a bug fix for someone else and you do not have the +means to test it, please tag this person here.