From b32e48a4405c63a027dc59a885621d3f7a14b9bc Mon Sep 17 00:00:00 2001 From: Patrick Ziegler Date: Fri, 17 Aug 2018 23:34:00 +0200 Subject: [PATCH] github: Custom issue templates (#1388) * github: Add template for bug or issue reports * github: Add template for build issues * github: Add tempalte for feature requests * github: Change 'New Issue' links to issue chooser Github provides an issue chooser dialog when custom issue templates are used. --- .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/build.md | 31 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ README.md | 4 +-- 4 files changed, 92 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/build.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..c968d6bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Bug or Issue Report +about: Create a report to help us improve + +--- + +## Describe the issue +*A clear and concise description of what the bug is.* + +**Expected behavior:** + +*A clear and concise description of what you expected to happen.* + +**Actual behavior:** + +*What actually happens* + +## 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: +* 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 new file mode 100644 index 00000000..9d52280f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build.md @@ -0,0 +1,31 @@ +--- +name: Build Issues +about: Report issues while building polybar + +--- + +## Build Process +*Describe how you build polybar, list the exact commands you are using:* + + + +**If you build polybar directly from this repository:** + +* 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.* +``` + +``` + +## Environment: +* Distro (with Version): + +## Additional context +*Add any other context that you think is necessary about the problem here.* diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..d2ca7275 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +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.* diff --git a/README.md b/README.md index 952d15bc..b39736d0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Here are a few screenshots showing you what it can look like: If you need help, check out the [Support](SUPPORT.md) page. -Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new) here on GitHub. +Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new/choose) here on GitHub. Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`. @@ -118,7 +118,7 @@ Find a more complete list on the [dedicated wiki page](https://github.com/jaagr/ ### Building from source -Please [report any problems](https://github.com/jaagr/polybar/issues/new) you run into when building the project. +Please [report any problems](https://github.com/jaagr/polybar/issues/new/choose) you run into when building the project. ~~~ sh $ git clone --branch 3.2 --recursive https://github.com/jaagr/polybar