From 9d31b51a632cf45097419b6e05f5ae4d05fed637 Mon Sep 17 00:00:00 2001 From: patrick96 Date: Thu, 26 Nov 2020 20:20:29 +0100 Subject: [PATCH] github: Cleanup issue templates We no longer allow people to create issues from a blank template. The templates for bug reports and build issues are also much more explicit in what they want from the user. --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++------ .github/ISSUE_TEMPLATE/build.md | 35 +++++++++++++++------ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 10 +++--- 4 files changed, 58 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d615fd50..24421294 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,41 +4,58 @@ about: Create a report for something that misbehaves --- -## Describe the issue -*A clear and concise description of what the bug is.* +## Checklist + + + +* [ ] I have read the appropriate section in the [contributing + guidelines](https://github.com/polybar/polybar/blob/master/CONTRIBUTING.md) +* [ ] I believe this issue is a problem with polybar itself and not a misconfiguration on my part. +* [ ] I have searched for other open and closed [issues](https://github.com/polybar/polybar/issues?q=is%3Aissue) that + may have already reported this problem. +* [ ] I have checked the [known issues](https://github.com/polybar/polybar/wiki/Known-Issues) page for this problem. + +## Describe the bug + **Expected behavior:** + -*A clear and concise description of what you expected to happen.* **Actual behavior:** + -*What actually happens* **Was it working before?** -* Did you also experience this bug in an earlier version of polybar? +* Did you also experience this bug in an earlier version of polybar (yes/no/don't know)? * If no, what was the last version where this worked correctly? ## To Reproduce -*A minimal but complete config with which the problem occurs:* + + + ```dosini ``` -*List any other steps needed to reproduce the issue besides starting polybar with the config you posted above.* + ## Polybar Log -*Post everything polybar outputs to the terminal when you run it and the issue occurs below* + ``` ``` ## Screenshots -*If applicable, add screenshots to help explain your problem.* + ## Environment: * WM: * Distro: * Output of `polybar -vvv`: +``` + +``` + ## Additional context -*Add any other context that you think is necessary about the problem here.* + diff --git a/.github/ISSUE_TEMPLATE/build.md b/.github/ISSUE_TEMPLATE/build.md index 9d52280f..9e0c86ab 100644 --- a/.github/ISSUE_TEMPLATE/build.md +++ b/.github/ISSUE_TEMPLATE/build.md @@ -1,25 +1,40 @@ --- name: Build Issues -about: Report issues while building polybar +about: Report issues while building polybar from source --- +## Checklist + + + +* [ ] I have followed every step on the [compiling wiki page](https://github.com/polybar/polybar/wiki/Compiling) and + installed all necessary dependencies. +* [ ] My problem is not described on the [known issues page](https://github.com/polybar/polybar/wiki/Known-Issues) +* [ ] I have searched for other open and closed [issues](https://github.com/polybar/polybar/issues?q=is%3Aissue) that + may have already reported this problem. +* [ ] I was able to reproduce this build issue in a clean build + ## Build Process -*Describe how you build polybar, list the exact commands you are using:* +**How did you build polybar?** + -**If you build polybar directly from this repository:** +* [ ] From a release archive (Which version?) +* [ ] By cloning this repository (What is the of `git describe --tags`?) +* [ ] Some other way (How?) -* Output of `git describe --tags`: - -**If you use some other way (like the AUR):** - -*List exactly where you are building from and which version you are building.* + ## Build Log -*Post everything that is output to the terminal while building polybar below. This HAS to include the output of the `cmake` and `make` commands, if you used them.* + ``` ``` @@ -28,4 +43,4 @@ about: Report issues while building polybar * Distro (with Version): ## Additional context -*Add any other context that you think is necessary about the problem here.* + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 58e9b58d..6a1549ad 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Polybar Gitter Room url: https://gitter.im/polybar/polybar diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index d2ca7275..0092b9f0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,16 +5,16 @@ about: Suggest an idea for this project --- ## 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 [...]* + ## Why does polybar need this feature? -*Describe why this feature would be useful to a large percentage of users (You need to convince us).* + ## Describe the solution you'd like -*A clear and concise description of how your solution would work. This includes possible config options that should be added.* + ## Describe alternatives you've considered -*A clear and concise description of any alternative solutions or features you've considered, if any.* + ## Additional context -*Add any other context or screenshots about the feature request here.* +