Skip to content

Commit 46d1aa5

Browse files
committed
Merge branch 'master' into roach/fixgit
2 parents 2c6b157 + 386bef6 commit 46d1aa5

3 files changed

Lines changed: 108 additions & 0 deletions

File tree

.github/contributing.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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 Fixes :bug:
10+
- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slack-events-api/issues), and if it isn't already tracked,
11+
[create a new issue](https://github.com/slackapi/python-slack-events-api/issues/new). Feel free to comment and add details in a closed Issue, 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]().
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/python-slack-events-api/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/python-slack-events-api).
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, a maintainer should discuss it with you. You can
44+
continue improve a Pull Request by adding commits to the branch from which the PR was created.
45+
46+
[Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)
47+
48+
## Creating a Pull Request
49+
50+
1. :fork_and_knife: Fork the repository on GitHub.
51+
2. :runner: Clone/fetch your fork to your local development machine. It's a good idea to run the tests just
52+
to make sure everything is in order.
53+
3. :herb: Create a new branch and check it out.
54+
4. :crystal_ball: Make your changes and commit them locally. Magic happens here!
55+
5. :arrow_heading_up: Push your new branch to your fork. (e.g. `git push username fix-issue-16`).
56+
6. :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `master` in this
57+
repository.

.github/issue_template.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
### Description
2+
3+
Describe your issue here.
4+
5+
### What type of issue is this? (place an `x` in one of the `[ ]`)
6+
- [ ] bug
7+
- [ ] enhancement (feature request)
8+
- [ ] question
9+
- [ ] documentation related
10+
- [ ] testing related
11+
- [ ] discussion
12+
13+
### Requirements
14+
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slack-events-api/blob/master/.github/contributing.md) and have done my best effort to follow them.
15+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
16+
* [ ] I've searched for any related issues and avoided creating a duplicate issue.
17+
18+
### Bug Report
19+
20+
Filling out the following details about bugs will help us solve your issue sooner.
21+
22+
#### Reproducible in:
23+
slackeventsapi version:
24+
python version:
25+
OS version(s):
26+
27+
#### Steps to reproduce:
28+
29+
1.
30+
2.
31+
3.
32+
33+
#### Expected result:
34+
35+
What you expected to happen
36+
37+
#### Actual result:
38+
39+
What actually happened
40+
41+
#### Attachments:
42+
43+
Logs, screenshots, screencast, sample project, funny gif, etc.

.github/pull_request_template.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
### Summary
2+
3+
Describe the goal of this PR. Mention any related Issue numbers.
4+
5+
### Requirements (place an `x` in each `[ ]`)
6+
7+
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/python-slack-events-api/blob/master/.github/contributing.md) and have done my best effort to follow them.
8+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).

0 commit comments

Comments
 (0)