diff options
author | Mustaqim Malim <mustaqim@protonmail.com> | 2019-12-14 13:03:09 +0000 |
---|---|---|
committer | Dave Davenport <DaveDavenport@users.noreply.github.com> | 2019-12-14 14:03:09 +0100 |
commit | 23124213924c5e61910bf447b2baf493ce7509bc (patch) | |
tree | aa14ff80049291389075dd2cd3fae75c1f39e8b4 | |
parent | e9dde8e2acb1bff9c7c43250de6f26b2589064c8 (diff) |
Add Issue and PR Templates (#1043)
* Issue Template: Add Bug report
* Issue Template: Add Feature request
* Pull Request Template
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md (renamed from .github/ISSUE_TEMPLATE.md) | 30 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 31 | ||||
-rw-r--r-- | .github/pull_request_template.md | 12 |
3 files changed, 68 insertions, 5 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7c283484..5ddf1fef 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,3 +1,10 @@ +--- +name: Bug report +about: rofi might be misbehaving +labels: bug +title: "[BUG] " +assignees: '' +--- :exclamation: First read the [guidelines](https://github.com/DaveDavenport/rofi/blob/next/.github/CONTRIBUTING.md)! This is not optional for any report/question. People must be able to understand the full context of the report when reading it, at any time. @@ -14,20 +21,33 @@ Output of `rofi -v` Output of `rofi -help` (in a [gist](https://gist.github.com/)) + ## Launch Command -The commandline used to launch **rofi** +`The commandline used to launch **rofi**` + ## Steps to reproduce -* Step 1 -* Step 2 +- Step 1 +- Step 2 ## What behaviour you see -* - +- ... + ## What behaviour you expect to see -* - +- ... + + +**Additional details:** +- Include a link to your private config +- Include screenshots/casts of your issue + + +**Please do not submit reports related to wayland, see +[here](https://github.com/DaveDavenport/rofi/wiki/Wayland) for more +information.** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..b3b6c2da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +--- +name: Feature request +about: It'd be cool if rofi did/had/would... +labels: Feature Request +title: "[REQUEST] " +assignees: '' +--- + +**Before creating a feature request:** +- First check the *next* branch, to see if the feature has already been + implemented. +- Check existing reports, see if it is already requested. + + +**Describe the feature** +- A clear description of the feature you want added. +- If the feature involves replacement of current functionality, how the new + functionality is better? +- If the feature is implemented in another application, include: + - Screenshots or screencasts of it + - Links to its implementation +- If possible try to explain how you would expect to use feature: + For example, should it be a configuration option or a hot-key. + + +**When reporting a feature request include the following information:** +- Rofi version: + - `rofi -v` + + +**Requesting a feature is no guarantee it will be added.** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..548c5d16 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +> Please follow these steps before submitting your PR: +> +> - [ ] This PR targets the `next` branch and not `master` +> - [ ] If your PR is a work in progress, include [WIP] in its title +> - [ ] Its commits' summaries are reasonably descriptive +> - [ ] You've described what this PR addresses below +> - [ ] You've included links to relevant issues, if any with `#issue_num` +> - [ ] You've deleted this template +> +> Thank you for contributing to rofi! <3 + +Your description here... |