Add .github files

jlcjohns · Aug 5, 2020 · 503eaa1 · 503eaa1
1 parent 9f4b735
commit 503eaa1
Show file tree

Hide file tree

Showing 11 changed files with 439 additions and 77 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,11 @@
+# Code of Conduct
+
+## Introduction
+
+Diversity and inclusion make our community strong. We encourage participation from the most varied and diverse backgrounds possible and want to be very clear about where we stand.
+
+Our goal is to maintain a safe, helpful and friendly community for everyone, regardless of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other defining characteristic.
+
+This code and related procedures also apply to unacceptable behavior occurring outside the scope of community activities, in all community venues (online and in-person) as well as in all one-on-one communications, and anywhere such behavior has the potential to adversely affect the safety and well-being of community members.
+
+For more information on our code of conduct, please visit [https://slackhq.github.io/code-of-conduct](https://slackhq.github.io/code-of-conduct)
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,45 @@
+---
+name: Bug
+about: Report a bug
+title: Bug
+labels: 'bug'
+assignees: ''
+---
+
+### Bug Report
+
+Filling out the following details about bugs will help us solve your issue sooner.
+
+#### Reproducible in:
+
+* `slack_bolt` version: (paste the output of `pip freeze | grep slack`)
+* Python runtime version: (paste the output of `python --version`)
+* OS info: (paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS)
+
+```bash
+pip freeze | grep slack
+python --version
+sw_vers && uname -v # or `ver`
+```
+
+#### Steps to reproduce:
+
+1.
+2.
+3.
+
+Also, please share the commands to run, source code, and project settings (e.g., setup.py).
+
+#### Expected result:
+
+(Tell what you expected to happen)
+
+#### Actual result:
+
+(Tell what actually happened with logs, screenshots)
+
+### Requirements (place an `x` in each of the `[ ]`)
+
+* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/bolt-python/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/bolt-python/issues).
diff --git a/.github/ISSUE_TEMPLATE/document.md b/.github/ISSUE_TEMPLATE/document.md
@@ -0,0 +1,21 @@
+---
+name: Document
+about: Submit an issue on documents
+title: docs
+labels: 'docs'
+assignees: ''
+---
+
+### Description
+
+(Describe your issue and goal here)
+
+#### The page URLs
+
+* https://slack.dev/bolt-python/
+
+### Requirements (place an `x` in each of the `[ ]`)
+
+* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/bolt-python/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/bolt-python/issues).
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -0,0 +1,23 @@
+---
+name: Enhancement / Feature Request
+about: Submit an enhancement/feature request
+title: enhancement
+labels: 'enhancement'
+assignees: ''
+---
+
+### Description
+
+(Describe your issue and goal here)
+
+#### Category (place an `x` in each of the `[ ]`)
+
+* [ ] `slack_bolt.App` and/or its core components
+* [ ] `slack_bolt.async_app.AsyncApp` and/or its core components
+* [ ] Adapters in `slack_bolt.adapter`
+
+### Requirements (place an `x` in each of the `[ ]`)
+
+* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/bolt-python/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/bolt-python/issues).
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,45 @@
+---
+name: Question
+about: Submit a question about this SDK
+title: question
+labels: 'question'
+assignees: ''
+---
+
+### Description
+
+(Describe your issue and goal here)
+
+#### Reproducible in:
+
+* `slack_bolt` version: (paste the output of `pip freeze | grep slack`)
+* Python runtime version: (paste the output of `python --version`)
+* OS info: (paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS)
+
+```bash
+pip freeze | grep slack
+python --version
+sw_vers && uname -v # or `ver`
+```
+
+#### Steps to reproduce:
+
+1.
+2.
+3.
+
+Also, please share the commands to run, source code, and project settings (e.g., setup.py).
+
+#### Expected result:
+
+(Tell what you expected to happen)
+
+#### Actual result:
+
+(Tell what actually happened with logs, screenshots)
+
+### Requirements (place an `x` in each of the `[ ]`)
+
+* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/bolt-python/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/bolt-python/issues).
diff --git a/.github/PULL_REQUEST_TEMPLATE/code_change.md b/.github/PULL_REQUEST_TEMPLATE/code_change.md
@@ -0,0 +1,23 @@
+---
+name: Code Change
+about: Submit an pull request
+title: code
+labels: ''
+assignees: ''
+---
+
+###  Summary
+
+(Describe the goal of this PR. Mention any related Issue numbers)
+
+#### Category (place an `x` in each of the `[ ]`)
+
+* [ ] `slack_bolt.App` and/or its core components
+* [ ] `slack_bolt.async_app.AsyncApp` and/or its core components
+* [ ] Adapters in `slack_bolt.adapter`
+
+### Requirements (place an `x` in each `[ ]`)
+
+* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/bolt-python/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 `./scripts/run_tests.sh` after making the changes.
diff --git a/.github/PULL_REQUEST_TEMPLATE/docs.md b/.github/PULL_REQUEST_TEMPLATE/docs.md
@@ -0,0 +1,16 @@
+---
+name: Document
+about: Submit an pull request on documents
+title: docs
+labels: 'docs'
+assignees: ''
+---
+
+###  Summary
+
+(Describe the goal of this PR. Mention any related Issue numbers)
+
+### Requirements (place an `x` in each `[ ]`)
+
+* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/bolt-python/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).
diff --git a/.github/contributing.md b/.github/contributing.md
@@ -0,0 +1,60 @@
+# Contributors Guide
+
+Interested in contributing? Awesome! Before you do though, please read our
+[Code of Conduct](https://slackhq.github.io/code-of-conduct). We take it very seriously, and expect that you will as
+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/bolt-python/issues), and if it isn't already tracked,
+   [create a new issue](https://github.com/slackapi/bolt-python/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/bolt-python/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/bolt-python/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`.
+
+## Requirements
+
+For your contribution to be accepted:
+
+- [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/bolt-python).
+- [x] The test suite must be complete and pass.
+- [x] The changes must be approved by code review.
+- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
+
+If the contribution doesn't meet the above criteria, you may fail our automated checks or a maintainer will discuss it with you. You can continue to improve a Pull Request by adding commits to the branch from which the PR was created.
+
+[Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)
+
+## Creating a Pull Request
+
+1.  :fork_and_knife: Fork the repository on GitHub.
+2.  :runner: Clone/fetch your fork to your local development machine. It's a good idea to run the tests just
+    to make sure everything is in order.
+3.  :herb: Create a new branch and check it out.
+4.  :crystal_ball: Make your changes and commit them locally. Magic happens here!
+5.  :arrow_heading_up: Push your new branch to your fork. (e.g. `git push username fix-issue-16`).
+6.  :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `main` in this
+    repository.
+
+## Maintainers
+
+There are more details about processes and workflow in the [Maintainer's Guide](./maintainers_guide.md).