Skip to content

Commit ece7ad0

Browse files
authored
Add GitHub issue templates for bugs, features, support and PRs (#755)
* Add GitHub issue templates for bugs, features, support and PRs Issues are either a bug report, feature request or support request. Labels are automaticaly added to the issues respectively: bug, enhancement, support. The templates suggest using the Slack before opening an issue, but no longer say it is a hard requirement. This might give a more inclusive impression to people reporting who are not Slack users. * List more information that should be provided for new issues
1 parent 4ca20ec commit ece7ad0

File tree

8 files changed

+85
-22
lines changed

8 files changed

+85
-22
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Bug report
3+
about: You found a bug in SDKMAN!
4+
title: "Bug: [A concise title]"
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
<!-- Thank you for using the SDKMAN! issue tracker! If you are unsure if it is a bug, then consider using the Slack chat before creating a new issue. Please understand, that we cannot offer regular support through GitHub issues and might close the issue, if it is not an actual bug! -->
10+
11+
**Bug report**
12+
<!-- A clear and concise description of the bug you encountered -->
13+
14+
**To reproduce**
15+
<!-- Steps to reproduce the behavior or verify the issue -->
16+
17+
**System info**
18+
<!-- Please add relevant information about your system:
19+
- OS (e.g. Windows, Linux, Mac, Cygwin, WSL, etc.) and version
20+
- Shell and version (e.g. `bash --version`/`zsh --version`)
21+
- The output of `sdk version`
22+
-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: SDKMAN! usage documentation
4+
url: https://sdkman.io/usage
5+
about: Find documentation about the available commands here.
6+
- name: SDKMAN! Slack community
7+
url: https://slack.sdkman.io/
8+
about: Please ask and answer questions about usage of SDKMAN! here.
9+
- name: SDKMAN! on Stack Overflow
10+
url: https://stackoverflow.com/questions/tagged/sdkman
11+
about: You might find help to common issues here.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for SDKMAN!
4+
title: 'Feature: [A concise title]'
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
<!-- Thank you for suggesting a new feature. Please consider discussing your idea in our Slack channel before requesting a new feature. -->
10+
11+
- [ ] I have read the [CONTRIBUTING guidelines](CONTRIBUTING.md)
12+
13+
**Feature request**
14+
<!-- A clear and precise description of what new or changed feature you want. Please include the reason, why you would need the feature. E.g. what problem does it solve? Or which workflow is currently frustrating and will be improved by this? -->
15+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Support request or question
3+
about: You need help using SDKMAN!
4+
title: "Question: [Short summary]"
5+
labels: 'support'
6+
assignees: ''
7+
8+
---
9+
<!-- Thank you for using SDKMAN!. We want to help users using the software, but we also try to avoid filling the issue tracker with too many support requests. We kindly ask you to use our Slack channel #user-issues before posting.
10+
11+
Please consider the following things. Note, that ignoring all of these might lead to the issue simply being closed. -->
12+
13+
- [ ] I have checked [the documentation](https://sdkman.io/usage)
14+
- [ ] I have done a quick search in [past issues](https://github.com/rclone/rclone/issues?q=) or [Stack Overflow](https://stackoverflow.com/questions/tagged/sdkman) for similar problems
15+
- [ ] I have brought up a conversation in the [Slack User Issues Channel](https://sdkman.slack.com/app_redirect?channel=user-issues)
16+
17+
**Question**
18+
<!-- A clear and concise description of the issue you are encountering -->
19+
20+
**System info**
21+
<!-- Please add relevant information about your system:
22+
- OS (e.g. Windows, Linux, Mac, Cygwin, WSL, etc.) and version
23+
- Shell and version (e.g. `bash --version`/`zsh --version`)
24+
- The output of `sdk version`
25+
-->

.github/pull_request_tempalte.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!-- To raise a new Pull Request, the following prerequisites need to be met. Please tick before proceeding: -->
2+
3+
- [ ] a GitHub Issue was opened for this feature / bug.
4+
- [ ] test coverage was added (Cucumber or Spock as appropriate).
5+
6+
Fixes #XXX

CONTRIBUTING.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
## Contributing
22

3-
We greatly value the feedback and contributions of our users. We have a simple process in place to facilitate this:
3+
We greatly value the feedback and contributions of our users.
44

5-
### Bugs and New Features
6-
7-
We keep a distinction between New Features and Bugs/Issues. We try to minimise the noise in our Github Issues stream by first having a conversation on [SDKMAN Slack](https://slack.sdkman.io). Simply sign up and join one of the following channels:
5+
We keep a distinction between Bugs/Issues, New Features and Support Requests. We also try to minimise the noise in our GitHub Issues stream and prefer having a conversation on [SDKMAN Slack](https://slack.sdkman.io) before creating new issues, if you are not fully sure how to categorize your request. Simply sign up and join one of the following channels:
86

97
- User Issues can be raised in our [User Issues channel](https://sdkman.slack.com/app_redirect?channel=user-issues).
108
- New Features or Enhancements can be discussed in our [CLI Development channel](https://sdkman.slack.com/app_redirect?channel=cli-development).
119

12-
After accepting a new feature or confirming that a bug was found, an Issue may be raised filling in the provided Issue Template on the [GitHub Issue Tracker](https://github.com/sdkman/sdkman-cli/issues/new).
10+
The [GitHub Issue Tracker](https://github.com/sdkman/sdkman-cli/issues/new) provides templates for required informations.
1311

14-
**Unfortunately we will close any Github Issues that have not followed this process of prior discussion.**
12+
**Unfortunately we might simply close any Github Issues that have not followed the requested template.**
1513

1614
### Pull Requests
1715

18-
Pull Requests are _always_ very welcome, but require the initial discussion on Slack followed by a Github Issue as described above. The PR template is to be filled in before submission, ensuring that it is _linked back_ to the Github Issue number by replacing `#XXX` with the appropriate Issue reference.
16+
Pull Requests are _always_ very welcome, but require a valid GitHub Issue as decribed above. The PR template is to be filled in before submission, ensuring that it is _linked back_ to the Github Issue number by replacing `#XXX` with the appropriate issue reference.
1917

20-
Each PR should also be accompanied by a passing test(s) proving it's validity (where feasible). The feasibility of the test will emerge in the initial discussions on Slack and in the Github Issue.
18+
Each PR should also be accompanied by a passing test(s) proving it's validity (where feasible). The feasibility of the test will emerge in the initial discussions of the issue.

ISSUE_TEMPLATE.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)