Skip to content

Commit

Permalink
Update .github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
seratch committed Aug 22, 2020
1 parent d494d32 commit 17f1160
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 72 deletions.
19 changes: 6 additions & 13 deletions .github/ISSUE_TEMPLATE/01_question.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
name: Question
about: Submit a question about this SDK
title: (Set a clear title describing your question)
labels: 'question'
assignees: ''
labels: "untriaged"
assignees: ""
---

## Description

(Describe your issue and goal here)

### Reproducible in:
Expand All @@ -34,9 +32,7 @@ sw_vers && uname -v # or `ver`

(Share the commands to run, source code, and project settings (e.g., setup.py))

1.
2.
3.
1. 2. 3.

### Expected result:

Expand All @@ -46,11 +42,8 @@ sw_vers && uname -v # or `ver`

(Tell what actually happened with logs, screenshots)

## Requirements (place an `x` in each of the `[ ]`)
### Requirements

(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:)
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:

* [ ] This is a question specific to this SDK project.
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.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).
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/python-slackclient/issues).
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/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.
20 changes: 8 additions & 12 deletions .github/ISSUE_TEMPLATE/02_enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@
name: Enhancement / Feature Request
about: Submit an enhancement/feature request
title: (Set a clear title describing your idea)
labels: 'enhancement'
assignees: ''
labels: "untriaged"
assignees: ""
---

## Description

(Describe your issue and goal here)

### Category (place an `x` in each of the `[ ]`)

* [ ] **slack.web.WebClient** (Web API client)
* [ ] **slack.webhook.WebHookClient** (Incoming Webhook, response_url sender)
* [ ] **slack.web.classes** (UI component builders)
* [ ] **slack.rtm.RTMClient** (RTM client)
- [ ] **slack.web.WebClient** (Web API client)
- [ ] **slack.webhook.WebHookClient** (Incoming Webhook, response_url sender)
- [ ] **slack.web.classes** (UI component builders)
- [ ] **slack.rtm.RTMClient** (RTM client)

## Requirements (place an `x` in each of the `[ ]`)
### Requirements

* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.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).
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/python-slackclient/issues).
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/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.
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/03_document.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,16 @@
name: Document
about: Submit an issue on documents
title: (Set a clear title describing your idea)
labels: 'docs'
assignees: ''
labels: "untriaged"
assignees: ""
---

## Description

(Describe your issue and goal here)

### The page URLs

* https://slack.dev/python-slackclient/
- https://slack.dev/python-slackclient/

## Requirements (place an `x` in each of the `[ ]`)
### Requirements

* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.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).
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/python-slackclient/issues).
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/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.
19 changes: 6 additions & 13 deletions .github/ISSUE_TEMPLATE/04_bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
name: Bug
about: Report the SDK bug
title: (Set a clear title describing the issue)
labels: 'bug'
assignees: ''
labels: "untriaged"
assignees: ""
---

## Bug Report

(Filling out the following details about bugs will help us solve your issue sooner.)

### Reproducible in:
Expand All @@ -34,9 +32,7 @@ sw_vers && uname -v # or `ver`

(Share the commands to run, source code, and project settings (e.g., setup.py))

1.
2.
3.
1. 2. 3.

### Expected result:

Expand All @@ -46,11 +42,8 @@ sw_vers && uname -v # or `ver`

(Tell what actually happened with logs, screenshots)

## Requirements (place an `x` in each of the `[ ]`)
### Requirements

(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:)
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:

* [ ] This is a bug specific to this SDK project.
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slackclient/blob/main/.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).
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/python-slackclient/issues).
Please read the [Contributing guidelines](https://github.com/slackapi/python-slackclient/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.
37 changes: 20 additions & 17 deletions .github/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,29 @@ well.
There are many ways you can contribute! :heart:

### Bug Reports and Fixes :bug:
- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slackclient/issues), and if it isn't already tracked,
[create a new issue](https://github.com/slackapi/python-slackclient/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
be reviewed.
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
- Include tests that isolate the bug and verifies that it was fixed.

- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slackclient/issues), and if it isn't already tracked,
[create a new issue](https://github.com/slackapi/python-slackclient/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
be reviewed.
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
- Include tests that isolate the bug and verifies that it was fixed.

### New Features :bulb:
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/slackapi/python-slackclient/issues/new).
- Issues that have been identified as a feature request will be labelled `enhancement`.
- If you'd like to implement the new feature, please wait for feedback from the project
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
not align well with the project objectives at the time.

- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/slackapi/python-slackclient/issues/new).
- Issues that have been identified as a feature request will be labelled `enhancement`.
- If you'd like to implement the new feature, please wait for feedback from the project
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
not align well with the project objectives at the time.

### Tests :mag:, Documentation :books:, Miscellaneous :sparkles:
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
alternative implementation of something that may have advantages over the way its currently
done, or you have any other change, we would be happy to hear about it!
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
- If not, [open an Issue](https://github.com/slackapi/python-slackclient/issues/new) to discuss the idea first.

- If you'd like to improve the tests, you want to make the documentation clearer, you have an
alternative implementation of something that may have advantages over the way its currently
done, or you have any other change, we would be happy to hear about it!
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
- If not, [open an Issue](https://github.com/slackapi/python-slackclient/issues/new) to discuss the idea first.

If you're new to our project and looking for some way to make your first contribution, look for
Issues labelled `good first contribution`.
Expand Down Expand Up @@ -57,4 +60,4 @@ If the contribution doesn't meet the above criteria, you may fail our automated

## Maintainers

There are more details about processes and workflow in the [Maintainer's Guide](./maintainers_guide.md).
There are more details about processes and workflow in the [Maintainer's Guide](./maintainers_guide.md).
16 changes: 8 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## Summary
## Summary

(Describe the goal of this PR. Mention any related Issue numbers)

### Category (place an `x` in each of the `[ ]`)

* [ ] **slack.web.WebClient** (Web API client)
* [ ] **slack.webhook.WebHookClient** (Incoming Webhook, response_url sender)
* [ ] **slack.web.classes** (UI component builders)
* [ ] **slack.rtm.RTMClient** (RTM client)
- [ ] **slack.web.WebClient** (Web API client)
- [ ] **slack.webhook.WebHookClient** (Incoming Webhook, response_url sender)
- [ ] **slack.web.classes** (UI component builders)
- [ ] **slack.rtm.RTMClient** (RTM client)

## Requirements (place an `x` in each `[ ]`)

* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slackclient/blob/main/.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).
* [ ] I've run `python setup.py validate` after making the changes.
- [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slackclient/blob/main/.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).
- [ ] I've run `python setup.py validate` after making the changes.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,5 @@ pip
tmp.txt
.DS_Store
logs/

.pytype/

0 comments on commit 17f1160

Please sign in to comment.