Update GitHub template files (#547)

* Update GitHub template files * Update the templates * Remove unncessary instructions * Update PR template as well * Update PR template as well
slackapi · Aug 22, 2020 · bd7c2b8 · bd7c2b8
1 parent 31b247e
commit bd7c2b8
Show file tree

Hide file tree

Showing 6 changed files with 161 additions and 50 deletions.
diff --git a/.github/ISSUE_TEMPLATE/01_question.md b/.github/ISSUE_TEMPLATE/01_question.md
@@ -0,0 +1,52 @@
+---
+name: Question
+about: Submit a question about this SDK
+title: (Set a clear title describing your question)
+labels: 'question', 'untriaged'
+assignees: ''
+---
+
+(Describe your issue and goal here)
+
+### Reproducible in:
+
+```bash
+mvn dependency:tree | grep com.slack.api
+gradle dependencies | grep com.slack.api
+java -version
+sw_vers && uname -v # or `ver`
+```
+
+#### The Slack SDK version
+
+(Paste the output of `mvn dependency:tree | grep com.slack.api` or `gradle dependencies | grep com.slack.api`)
+
+#### Java Runtime version
+
+(Paste the output of `java -version`)
+
+#### OS info
+
+(Paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS)
+
+#### Steps to reproduce:
+
+(Share the commands to run, source code, and project settings (e.g., pom.xml/build.gradle))
+
+1.
+2.
+3.
+
+#### Expected result:
+
+(Tell what you expected to happen)
+
+#### Actual result:
+
+(Tell what actually happened with logs, screenshots)
+
+### Requirements
+
+Please make sure if this topic is specific to this SDK. For general questions/issues about Slack API platform or its server-side, could you submit questions at https://my.slack.com/help/requests/new instead. :bow:
+
+Please read the [Contributing guidelines](https://github.com/slackapi/java-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to the those rules.
diff --git a/.github/ISSUE_TEMPLATE/02_enhancement.md b/.github/ISSUE_TEMPLATE/02_enhancement.md
@@ -0,0 +1,24 @@
+---
+name: Enhancement / Feature Request
+about: Submit an enhancement/feature request
+title: (Set a clear title describing your idea)
+labels: 'untriaged'
+assignees: ''
+---
+
+(Describe your issue and goal here)
+
+### Category (place an `x` in each of the `[ ]`)
+
+* [ ] **bolt** (Bolt for Java)
+* [ ] **bolt-{sub modules}** (Bolt for Java - optional modules)
+* [ ] **slack-api-client** (Slack API Clients)
+* [ ] **slack-api-model** (Slack API Data Models)
+* [ ] **slack-api-*-kotlin-extension** (Kotlin Extensions for Slack API Clients)
+* [ ] **slack-app-backend** (The primitive layer of Bolt for Java)
+
+### Requirements
+
+Please make sure if this topic is specific to this SDK. For general questions/issues about Slack API platform or its server-side, could you submit questions at https://my.slack.com/help/requests/new instead. :bow:
+
+Please read the [Contributing guidelines](https://github.com/slackapi/java-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to the those rules.
diff --git a/.github/ISSUE_TEMPLATE/03_document.md b/.github/ISSUE_TEMPLATE/03_document.md
@@ -0,0 +1,22 @@
+---
+name: Document
+about: Submit an issue on documents
+title: (Set a clear title describing your idea)
+labels: 'untriaged'
+assignees: ''
+---
+
+(Describe your issue and goal here)
+
+### The page URLs
+
+(List the URLs to update here)
+
+* https://slack.dev/java-slack-sdk/
+* (examples in this repository)
+
+### Requirements
+
+Please make sure if this topic is specific to this SDK. For general questions/issues about Slack API platform or its server-side, could you submit questions at https://my.slack.com/help/requests/new instead. :bow:
+
+Please read the [Contributing guidelines](https://github.com/slackapi/java-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to the those rules.
diff --git a/.github/ISSUE_TEMPLATE/04_bug.md b/.github/ISSUE_TEMPLATE/04_bug.md
@@ -0,0 +1,52 @@
+---
+name: Bug
+about: Report the SDK bug
+title: (Set a clear title describing the issue)
+labels: 'untriaged'
+assignees: ''
+---
+
+(Describe your issue and goal here)
+
+### Reproducible in:
+
+```bash
+mvn dependency:tree | grep com.slack.api
+gradle dependencies | grep com.slack.api
+java -version
+sw_vers && uname -v # or `ver`
+```
+
+#### The Slack SDK version
+
+(Paste the output of `mvn dependency:tree | grep com.slack.api` or `gradle dependencies | grep com.slack.api`)
+
+#### Java Runtime version
+
+(Paste the output of `java -version`)
+
+#### OS info
+
+(Paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS)
+
+#### Steps to reproduce:
+
+(Share the commands to run, source code, and project settings (e.g., pom.xml/build.gradle))
+
+1.
+2.
+3.
+
+#### Expected result:
+
+(Tell what you expected to happen)
+
+#### Actual result:
+
+(Tell what actually happened with logs, screenshots)
+
+### Requirements
+
+Please make sure if this topic is specific to this SDK. For general questions/issues about Slack API platform or its server-side, could you submit questions at https://my.slack.com/help/requests/new instead. :bow:
+
+Please read the [Contributing guidelines](https://github.com/slackapi/java-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to the those rules.
diff --git a/.github/issue_template.md b/.github/issue_template.md
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,9 +1,14 @@
-###  Summary
+(Describe the goal of this PR. Mention any related Issue numbers)
 
-**TODO**:
-Describe the goal of this PR. Mention any related Issue numbers.
+### Category (place an `x` in each of the `[ ]`)
 
-### Requirements (place an `x` in each `[ ]`)
+* [ ] **bolt** (Bolt for Java)
+* [ ] **bolt-{sub modules}** (Bolt for Java - optional modules)
+* [ ] **slack-api-client** (Slack API Clients)
+* [ ] **slack-api-model** (Slack API Data Models)
+* [ ] **slack-api-*-kotlin-extension** (Kotlin Extensions for Slack API Clients)
+* [ ] **slack-app-backend** (The primitive layer of Bolt for Java)
 
-* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/java-slack-sdk/blob/master/.github/contributing.md) and have done my best effort to follow them.
-* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
+## Requirements
+
+Please read the [Contributing guidelines](https://github.com/slackapi/java-slack-sdk/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to the those rules.