From 22014c70c4540609166ee333f66ebec0e2de57e0 Mon Sep 17 00:00:00 2001 From: Patrick Ziegler Date: Sun, 10 Oct 2021 14:00:18 +0200 Subject: [PATCH] Use the new GitHub issue forms (#2530) * Use the new GitHub issue forms This now automatically adds labels and marks certain information as mandatory. It also automatically formats some fields (e.g. polybar config). Ref: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms * Update bug_report issue link * Fix bug_report description --- .github/ISSUE_TEMPLATE/bug_report.md | 61 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 112 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/build.md | 46 --------- .github/ISSUE_TEMPLATE/build.yml | 81 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 2 +- CONTRIBUTING.md | 2 +- 6 files changed, 195 insertions(+), 109 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/build.md create mode 100644 .github/ISSUE_TEMPLATE/build.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 24421294..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -name: Bug Report -about: Create a report for something that misbehaves - ---- - -## 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:** - - - -**Actual behavior:** - - - -**Was it working before?** -* 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 - - - -```dosini - -``` - - -## Polybar Log - -``` - -``` - -## Screenshots - - -## Environment: -* WM: -* Distro: -* Output of `polybar -vvv`: - -``` - -``` - -## Additional context - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..ad0a991a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,112 @@ +name: Bug Report +description: Create a report for something that misbehaves +title: "[Bug]: " +labels: ["bug", "needs confirmation"] +body: + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please carefully go through this checklist and check each option. + options: + - label: I have read the appropriate section in the [contributing guidelines](https://github.com/polybar/polybar/blob/master/CONTRIBUTING.md) + required: true + - label: I believe this issue is a problem with polybar itself and not a misconfiguration on my part + required: true + - label: 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 + required: true + - label: I have checked the [known issues](https://github.com/polybar/polybar/wiki/Known-Issues) page for this problem. + required: true + - label: I have followed the [debugging guide](https://github.com/polybar/polybar/wiki/Debugging-your-Config) to narrow down the problem to a minimal config. + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Any steps to take and commands to run to reproduce this issue. + placeholder: | + 1. `polybar -c ... bar` + 2. ... + validations: + required: true + - type: textarea + id: config + attributes: + label: Minimal config + description: A minimal but complete config with which the problem occurs. + render: dosini + placeholder: | + [bar/example] + ... + + [module/...] + ... + validations: + required: true + - type: textarea + id: logs + attributes: + label: Polybar log + description: Post everything polybar prints to the terminal when you run it and the issue occurs. If possible, run polybar with a higher log level (e.g. `trace` or `info`). + render: text + placeholder: | + notice: Parsing config file: ... + ... + - type: textarea + id: expected + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What actually happens + validations: + required: true + - type: input + id: wm + attributes: + label: Window Manager and Version + placeholder: ex. i3-gaps 4.19.1 + validations: + required: true + - type: input + id: distro + attributes: + label: Linux Distribution + placeholder: ex. Ubuntu 21.04 + validations: + required: true + - type: textarea + id: version + attributes: + label: Polybar version + description: Output of `polybar -vvv` + render: text + placeholder: | + polybar 3.5.7 + + Features: +alsa +curl +i3 +mpd +network(libnl) +pulseaudio +xkeyboard + + X extensions: +randr (+monitors) +composite +xkb +xrm +xcursor + + Build type: Release + Compiler: /usr/bin/c++ + Compiler flags: -D_FORTIFY_SOURCE=2 -march=x86-64 -mtune=generic -O2 -pipe -fno-plt -O3 -DNDEBUG -Wall -Wextra -Wpedantic -Wsuggest-override + Linker flags: -Wall -Wextra -Wpedantic -Wsuggest-override -Wall -Wextra -Wpedantic -Wsuggest-override + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context / Screenshots + description: If applicaple, add screenshots and additional context to explain your problem + validations: + required: false + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! :heart: diff --git a/.github/ISSUE_TEMPLATE/build.md b/.github/ISSUE_TEMPLATE/build.md deleted file mode 100644 index 0693dc83..00000000 --- a/.github/ISSUE_TEMPLATE/build.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Build Issues -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 - -**How did you build polybar?** - - - -* [ ] From a release archive (Which version?) -* [ ] By cloning this repository (What is the output of `git describe --tags`?) -* [ ] Some other way (How?) - - - - -## Build Log - -``` - -``` - -## Environment: -* Distro (with Version): - -## Additional context - diff --git a/.github/ISSUE_TEMPLATE/build.yml b/.github/ISSUE_TEMPLATE/build.yml new file mode 100644 index 00000000..d6a5767f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build.yml @@ -0,0 +1,81 @@ +name: Build Issues +description: Report issues while building polybar from source +labels: ["build", "needs confirmation"] +body: + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please carefully go through this checklist and check each option. + options: + - label: I have followed every step on the [compiling wiki page](https://github.com/polybar/polybar/wiki/Compiling) and installed all necessary dependencies. + required: true + - label: My problem is not described on the [known issues page](https://github.com/polybar/polybar/wiki/Known-Issues) + required: true + - label: 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. + required: true + - label: I was able to reproduce this build issue in a clean build + required: true + - type: dropdown + id: source + attributes: + label: From where are you building polybar? + options: + - From a release archive + - By cloning this repository + - Some other way (How?) + validations: + required: true + - type: input + id: how + attributes: + label: Describe how you are building polybar. + description: Only if you selected "Some other way". + placeholder: ex. polybar from the AUR + validations: + required: false + - type: input + id: version + attributes: + label: Version + description: What version of polybar are you trying to build? If you are building directly from git, this is the output of `git describe --tags`. + placeholder: ex. 3.5.7 + validations: + required: true + - type: textarea + id: commands + attributes: + label: Build Process + description: List the exact commands you are using to build polybar + render: shell + placeholder: | + mkdir build + cd build + cmake .. + ... + validations: + required: true + - type: textarea + id: logs + attributes: + label: Build log + description: | + Copy-paste all the terminal output produced while building polybar. + This MUST include the output of the `cmake`, `make`, and/or `build.sh` commands, if you used them. + render: text + validations: + required: true + - type: input + id: distro + attributes: + label: Linux Distribution + placeholder: ex. Ubuntu 21.04 + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context that you think is necessary about the problem here + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0092b9f0..57279e36 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature request about: Suggest an idea for this project - +labels: feature, needs confirmation --- ## Is your feature request related to a problem? Please describe. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee1da0cb..e88e06cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ are awesome! :tada: ## Bug Reports Bugs should be reported at the polybar issue tracker, using the [bug report -template](https://github.com/polybar/polybar/issues/new?template=bug_report.md). +template](https://github.com/polybar/polybar/issues/new?template=bug_report.yml). Make sure you fill out all the required sections. Before opening a bug report, please search our [issue