Skip to content

Commit ab6dcec

Browse files
WilliamBergaminWilliamBergamin
authored
feat: Add contributing requirements (#3)
* Introduce contributor requirements
1 parent e81b0c5 commit ab6dcec

File tree

5 files changed

+188
-0
lines changed

5 files changed

+188
-0
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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
5+
seriously, and expect that you will as well.
6+
7+
There are many ways you can contribute! :heart:
8+
9+
## :bug: Bug Reports and Fixes
10+
11+
- If you find a bug, please search for it in the
12+
[Issues](https://github.com/slackapi/python-slack-hooks/issues), and if it isn't
13+
already tracked,
14+
[create a new Bug Report Issue](https://github.com/slackapi/python-slack-hooks/issues/new/choose).
15+
Fill out the "Bug Report" section of the issue template. Even if an Issue is
16+
closed, feel free to comment and add details, it will still be reviewed.
17+
- Issues that have already been identified as a bug (note: able to reproduce)
18+
will be labelled `bug`.
19+
- If you'd like to submit a fix for a bug,
20+
[send a Pull Request](#creating-a-pull-request) and mention the Issue number.
21+
- Include tests that isolate the bug and verifies that it was fixed.
22+
23+
## :bulb: New Features
24+
25+
- If you'd like to add new functionality to this project, describe the problem
26+
you want to solve in a
27+
[new Feature Request Issue](https://github.com/slackapi/python-slack-hooks/issues/new/choose).
28+
- Issues that have been identified as a feature request will be labelled
29+
`enhancement`.
30+
- If you'd like to implement the new feature, please wait for feedback from the
31+
project maintainers before spending too much time writing the code. In some
32+
cases, `enhancement`s may not align well with the project objectives at the
33+
time.
34+
35+
## :mag: Tests, :books: Documentation,:sparkles: Miscellaneous
36+
37+
- If you'd like to improve the tests, you want to make the documentation
38+
clearer, you have an alternative implementation of something that may have
39+
advantages over the way its currently done, or you have any other change, we
40+
would be happy to hear about it!
41+
- If its a trivial change, go ahead and
42+
[send a Pull Request](#creating-a-pull-request) with the changes you have in
43+
mind.
44+
- If not, [open an Issue](https://github.com/slackapi/python-slack-hooks/issues/new)
45+
to discuss the idea first.
46+
47+
If you're new to our project and looking for some way to make your first
48+
contribution, look for Issues labelled `good first contribution`.
49+
50+
## Requirements
51+
52+
For your contribution to be accepted:
53+
54+
- [x] You must have signed the
55+
[Contributor License Agreement (CLA)](https://cla.salesforce.com/sign-cla).
56+
- [x] The test suite must be complete and pass.
57+
- [x] The changes must be approved by code review.
58+
- [x] Commits should be atomic and messages must be descriptive. Related issues
59+
should be mentioned by Issue number.
60+
61+
If the contribution doesn't meet the above criteria, you may fail our automated
62+
checks or a maintainer will discuss it with you. You can continue to improve a
63+
Pull Request by adding commits to the branch from which the PR was created.
64+
65+
[Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)
66+
67+
## Creating a Pull Request
68+
69+
1. :fork_and_knife: Fork the repository on GitHub.
70+
2. :runner: Clone/fetch your fork to your local development machine. It's a good
71+
idea to run the tests just to make sure everything is in order.
72+
3. :herb: Create a new branch and check it out.
73+
4. :crystal_ball: Make your changes and commit them locally. Magic happens here!
74+
5. :arrow_heading_up: Push your new branch to your fork. (e.g.
75+
`git push username fix-issue-16`).
76+
6. :inbox_tray: Open a Pull Request on github.com from your new branch on your
77+
fork to `main` in this repository.
78+
79+
## Maintainers
80+
81+
There are more details about processes and workflow in the
82+
[Maintainer's Guide](https://github.com/slackapi/python-slack-hooks/blob/main/.github/maintainers_guide.md).

‎.github/ISSUE_TEMPLATE/bug.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug encountered while using this project
4+
title: '[BUG] <title>'
5+
---
6+
7+
<!-- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/python-slack-hooks/issues), and if it isn't already tracked then create a new issue -->
8+
9+
**The `deno-slack` versions**
10+
11+
<!-- Paste the output of `pip freeze | grep slack` -->
12+
13+
**Python runtime version**
14+
15+
<!-- Paste the output of `python --version` -->
16+
17+
**OS info**
18+
19+
<!-- Paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS -->
20+
21+
**Describe the bug**
22+
23+
<!-- A clear and concise description of what the bug is. -->
24+
25+
**Steps to reproduce**
26+
27+
<!-- Share the commands to run, source code, and project settings -->
28+
1.
29+
2.
30+
3.
31+
32+
**Expected result**
33+
34+
<!-- Tell what you expected to happen -->
35+
36+
**Actual result**
37+
38+
<!-- Tell what actually happened with logs, screenshots -->
39+
40+
**Requirements**
41+
42+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-hooks/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 those rules.

‎.github/ISSUE_TEMPLATE/feature.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature for this project
4+
title: '[FEATURE] <title>'
5+
---
6+
7+
<!-- If you have a feature request, please search for it in the [Issues](https://github.com/slackapi/python-slack-hooks/issues), and if it isn't already tracked then create a new issue -->
8+
9+
**Description of the problem being solved**
10+
11+
<!-- Please describe the problem you want to solve -->
12+
13+
**Alternative solutions**
14+
15+
<!-- Please describe the solutions you've considered -->
16+
17+
**Requirements**
18+
19+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-hooks/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 those rules.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Question
3+
about: Ask a question about this project
4+
title: '[QUERY] <title>'
5+
label: question
6+
---
7+
8+
<!-- If you have a question, please search for it in the [Issues](https://github.com/slackapi/python-slack-hooks/issues), and if it isn't already tracked then create a new issue -->
9+
10+
**Question**
11+
12+
<!-- A clear and concise question with steps to reproduce -->
13+
14+
**Context**
15+
16+
<!-- Any additional context to your question -->
17+
18+
**Environment**
19+
20+
<!-- Paste the output of `cat import_map.json | grep deno-slack` -->
21+
<!-- Paste the output of `deno --version` -->
22+
<!-- Paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS -->
23+
24+
**Requirements**
25+
26+
Please read the [Contributing guidelines](https://github.com/slackapi/python-slack-hooks/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 those rules.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Thanks for sending a pull request! -->
2+
3+
### Summary
4+
5+
<!-- A high level description of the change that will make it easier for your reviewer to make sense of the changes -->
6+
7+
### Testing
8+
9+
<!-- Describe what steps a reviewer should follow to test your changes. -->
10+
11+
### Special notes
12+
13+
<!-- Any special notes reviewers should be aware of. -->
14+
15+
### Requirements <!-- place an `x` in each `[ ]` -->
16+
17+
* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/python-slack-hooks/blob/main/.github/CONTRIBUTING.md) and have done my best effort to follow them.
18+
* [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
19+
* [ ] I've run `./scripts/install_and_run_tests.sh` after making the changes.

0 commit comments

Comments
 (0)