X Tutup
Skip to content

Commit 503eaa1

Browse files
seratchseratch
committed
Add .github files
1 parent 9f4b735 commit 503eaa1

File tree

11 files changed

+439
-77
lines changed

11 files changed

+439
-77
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Code of Conduct
2+
3+
## Introduction
4+
5+
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.
6+
7+
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.
8+
9+
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.
10+
11+
For more information on our code of conduct, please visit [https://slackhq.github.io/code-of-conduct](https://slackhq.github.io/code-of-conduct)

‎.github/ISSUE_TEMPLATE/bug.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug
3+
about: Report a bug
4+
title: Bug
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
### Bug Report
10+
11+
Filling out the following details about bugs will help us solve your issue sooner.
12+
13+
#### Reproducible in:
14+
15+
* `slack_bolt` version: (paste the output of `pip freeze | grep slack`)
16+
* Python runtime version: (paste the output of `python --version`)
17+
* OS info: (paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS)
18+
19+
```bash
20+
pip freeze | grep slack
21+
python --version
22+
sw_vers && uname -v # or `ver`
23+
```
24+
25+
#### Steps to reproduce:
26+
27+
1.
28+
2.
29+
3.
30+
31+
Also, please share the commands to run, source code, and project settings (e.g., setup.py).
32+
33+
#### Expected result:
34+
35+
(Tell what you expected to happen)
36+
37+
#### Actual result:
38+
39+
(Tell what actually happened with logs, screenshots)
40+
41+
### Requirements (place an `x` in each of the `[ ]`)
42+
43+
* [ ] 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.
44+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
45+
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/bolt-python/issues).

‎.github/ISSUE_TEMPLATE/document.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Document
3+
about: Submit an issue on documents
4+
title: docs
5+
labels: 'docs'
6+
assignees: ''
7+
---
8+
9+
### Description
10+
11+
(Describe your issue and goal here)
12+
13+
#### The page URLs
14+
15+
* https://slack.dev/bolt-python/
16+
17+
### Requirements (place an `x` in each of the `[ ]`)
18+
19+
* [ ] 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.
20+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
21+
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/bolt-python/issues).

‎.github/ISSUE_TEMPLATE/enhancement.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Enhancement / Feature Request
3+
about: Submit an enhancement/feature request
4+
title: enhancement
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
### Description
10+
11+
(Describe your issue and goal here)
12+
13+
#### Category (place an `x` in each of the `[ ]`)
14+
15+
* [ ] `slack_bolt.App` and/or its core components
16+
* [ ] `slack_bolt.async_app.AsyncApp` and/or its core components
17+
* [ ] Adapters in `slack_bolt.adapter`
18+
19+
### Requirements (place an `x` in each of the `[ ]`)
20+
21+
* [ ] 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.
22+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
23+
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/bolt-python/issues).

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Question
3+
about: Submit a question about this SDK
4+
title: question
5+
labels: 'question'
6+
assignees: ''
7+
---
8+
9+
### Description
10+
11+
(Describe your issue and goal here)
12+
13+
#### Reproducible in:
14+
15+
* `slack_bolt` version: (paste the output of `pip freeze | grep slack`)
16+
* Python runtime version: (paste the output of `python --version`)
17+
* OS info: (paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS)
18+
19+
```bash
20+
pip freeze | grep slack
21+
python --version
22+
sw_vers && uname -v # or `ver`
23+
```
24+
25+
#### Steps to reproduce:
26+
27+
1.
28+
2.
29+
3.
30+
31+
Also, please share the commands to run, source code, and project settings (e.g., setup.py).
32+
33+
#### Expected result:
34+
35+
(Tell what you expected to happen)
36+
37+
#### Actual result:
38+
39+
(Tell what actually happened with logs, screenshots)
40+
41+
### Requirements (place an `x` in each of the `[ ]`)
42+
43+
* [ ] 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.
44+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
45+
* [ ] I've searched for any related issues and avoided creating a duplicate issue [here](https://github.com/slackapi/bolt-python/issues).

‎.github/PULL_REQUEST_TEMPLATE/code_change.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Code Change
3+
about: Submit an pull request
4+
title: code
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
### Summary
10+
11+
(Describe the goal of this PR. Mention any related Issue numbers)
12+
13+
#### Category (place an `x` in each of the `[ ]`)
14+
15+
* [ ] `slack_bolt.App` and/or its core components
16+
* [ ] `slack_bolt.async_app.AsyncApp` and/or its core components
17+
* [ ] Adapters in `slack_bolt.adapter`
18+
19+
### Requirements (place an `x` in each `[ ]`)
20+
21+
* [ ] 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.
22+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
23+
* [ ] I've run `./scripts/run_tests.sh` after making the changes.

‎.github/PULL_REQUEST_TEMPLATE/docs.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Document
3+
about: Submit an pull request on documents
4+
title: docs
5+
labels: 'docs'
6+
assignees: ''
7+
---
8+
9+
### Summary
10+
11+
(Describe the goal of this PR. Mention any related Issue numbers)
12+
13+
### Requirements (place an `x` in each `[ ]`)
14+
15+
* [ ] 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.
16+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).

‎.github/contributing.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributors Guide
2+
3+
Interested in contributing? Awesome! Before you do though, please read our
4+
[Code of Conduct](https://slackhq.github.io/code-of-conduct). We take it very seriously, and expect that you will as
5+
well.
6+
7+
There are many ways you can contribute! :heart:
8+
9+
### Bug Reports and Fixes :bug:
10+
- 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,
11+
[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
12+
be reviewed.
13+
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
14+
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
15+
- Include tests that isolate the bug and verifies that it was fixed.
16+
17+
### New Features :bulb:
18+
- 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).
19+
- Issues that have been identified as a feature request will be labelled `enhancement`.
20+
- If you'd like to implement the new feature, please wait for feedback from the project
21+
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
22+
not align well with the project objectives at the time.
23+
24+
### Tests :mag:, Documentation :books:, Miscellaneous :sparkles:
25+
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
26+
alternative implementation of something that may have advantages over the way its currently
27+
done, or you have any other change, we would be happy to hear about it!
28+
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
29+
- If not, [open an Issue](https://github.com/slackapi/bolt-python/issues/new) to discuss the idea first.
30+
31+
If you're new to our project and looking for some way to make your first contribution, look for
32+
Issues labelled `good first contribution`.
33+
34+
## Requirements
35+
36+
For your contribution to be accepted:
37+
38+
- [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/bolt-python).
39+
- [x] The test suite must be complete and pass.
40+
- [x] The changes must be approved by code review.
41+
- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
42+
43+
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.
44+
45+
[Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)
46+
47+
## Creating a Pull Request
48+
49+
1. :fork_and_knife: Fork the repository on GitHub.
50+
2. :runner: Clone/fetch your fork to your local development machine. It's a good idea to run the tests just
51+
to make sure everything is in order.
52+
3. :herb: Create a new branch and check it out.
53+
4. :crystal_ball: Make your changes and commit them locally. Magic happens here!
54+
5. :arrow_heading_up: Push your new branch to your fork. (e.g. `git push username fix-issue-16`).
55+
6. :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `main` in this
56+
repository.
57+
58+
## Maintainers
59+
60+
There are more details about processes and workflow in the [Maintainer's Guide](./maintainers_guide.md).

0 commit comments

Comments
 (0)
X Tutup