Skip to content
This repository was archived by the owner on Aug 15, 2022. It is now read-only.

Commit 3cd9b9a

Browse files
author
Jeff Ammons
committed
Standardizing docs between python-slackclient and rtmbot
Added copyright to License File Added standard format for issues/PRs Added Code of Conduct Moved doc/ to docs/
1 parent 7cbbb03 commit 3cd9b9a

File tree

13 files changed

+124
-0
lines changed

13 files changed

+124
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing at Slack
2+
3+
![Header Image](contributing_header_slack.png)
4+
5+
## Before Contributing
6+
7+
Before contributing, please read our [Code of Conduct](./CODE_OF_CONDUCT.md). We take it very seriously, and expect that you will as well.
8+
9+
## New Issues
10+
11+
Before opening a new issue, please consider:
12+
13+
- Reading [the documentation](https://github.com/slackhq/python-rtmbot/blob/master/README.md) and [the changelog](https://github.com/slackhq/python-rtmbot/blob/master/CHANGELOG.md) first.
14+
- Searching for any related issues and avoid creating duplicated issues.
15+
- Adding details, diagnoses, screenshots or any type of useful information in existing issues, even if they are marked as closed. The team will still review it.
16+
- Trying out the examples [provided in this repository](https://github.com/slackhq/python-rtmbot/tree/master/examples).
17+
- Taking the time to think of a solution and [**open a pull request**](#new-pull-requests) for either improving the documentation, fixing a bug or suggesting a feature.
18+
- Finally, **[open an issue]**(https://github.com/slackhq/python-rtmbot/issues/new) to report a bug, ask for help or suggest a feature. The more information you give, the better people can help you.
19+
20+
21+
## New Pull Requests
22+
23+
We love pull requests and we are generally very receptive to contributions. Things to keep in mind:
24+
25+
- [Fork the repository](https://github.com/slackhq/python-rtmbot) and make sure to work on a branch up to date with origin master.
26+
- Do your thing!
27+
- Be mindful about doing atomic commits, adding documentation to your changes, not refactoring too much.
28+
- Add tests covering the new code or functionality you are adding.
29+
- Add a descriptive title and add any useful information for the reviewer. If your contribution is a user facing thing, please attach a screenshot and/or screencast (gif preferrably).
30+
- Read and agree to our [Contributor License Agreement (CLA)](https://docs.google.com/a/slack-corp.com/forms/d/1q_w8rlJG_x_xJOoSUMNl7R35rkpA7N6pUkKhfHHMD9c/viewform). _We cannot accept your PR without your agreement to our CLA_.
31+
- Create your pull request (yay!). If it is in relation to an existing issue, please mention it on the title or description.
32+
33+
[Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)

.github/ISSUE_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
* [ ] I've read and understood the [Contributing guidelines](./CONTRIBUTING.md) and have done my best effort to follow them.
2+
* [ ] I've read and agree to the [Code of Conduct](./CODE_OF_CONDUCT.md).
3+
* [ ] I've searched for any related issues and avoided creating a duplicate issue.
4+
5+
#### Description
6+
> e.g. Description of the bug or feature
7+
8+
#### Reproducible in:
9+
* [ ] This is reproducible in the sample project.
10+
RTMBot version:
11+
Python version:
12+
OS Version:
13+
14+
#### Steps to reproduce:
15+
16+
1.
17+
2.
18+
3.
19+
20+
### Expected result:
21+
> e.g. What you expected to happen
22+
23+
### Actual result:
24+
> e.g. What actually happened
25+
26+
### Attachments:
27+
> e.g. Logs, screenshots, screencast, sample project, funny gif, etc.
28+
29+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* [ ] I've read and understood the [Contributing guidelines](./CONTRIBUTING.md) and have done my best effort to follow them.
2+
* [ ] I've read and agree to the [Code of Conduct](./CODE_OF_CONDUCT.md).
3+
* [ ] I've been mindful about doing atomic commits, adding documentation to my changes, not refactoring too much.
4+
* [ ] I've a descriptive title and added any useful information for the reviewer. Where appropriate, I've attached a screenshot and/or screencast (gif preferrably).
5+
* [ ] I've written tests to cover the new code and functionality included in this PR.
6+
* [ ] I've read, agree to, and signed the [Contributor License Agreement (CLA)](https://docs.google.com/a/slack-corp.com/forms/d/1q_w8rlJG_x_xJOoSUMNl7R35rkpA7N6pUkKhfHHMD9c/viewform).
7+
8+
#### PR Summary
9+
> e.g. New functionality for producing whatsits.
10+
11+
#### Related Issues
12+
> e.g. Fixes #206 and closes #230
13+
14+
#### Test strategy
15+
> e.g. Add tests around whatsit production.
98.6 KB
Loading

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### v0.2.0 (2016-03-25)
2+
3+
* Fixed unicode handling to make things work in python 2.7 and 3.5.
4+
* Changed versioning scheme to Semver.
5+
6+
### v0.10 (2016-02-28)
7+
8+
* Refactored the RTMBot Class to make it more isolated from the script that runs the bot
9+

CODE_OF_CONDUCT.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Slack open source code of conduct
2+
3+
4+
## Introduction
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+
## Expected Behavior
12+
* Be welcoming.
13+
* Be kind.
14+
* Look out for each other.
15+
16+
## Unacceptable Behavior
17+
* Conduct or speech which might be considered sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory or offensive in nature.
18+
* Unwelcome, suggestive, derogatory or inappropriate nicknames or terms.
19+
* Disrespect towards others. (Jokes, innuendo, dismissive attitudes.)
20+
* Intimidation or harassment (online or in-person). Please read the [Citizen Code of Conduct](http://citizencodeofconduct.org/) for how we interpret harassment.
21+
* Disrespect towards differences of opinion.
22+
* Inappropriate attention or contact. Be aware of how your actions affect others. If it makes someone uncomfortable, stop.
23+
* Not understanding the differences between constructive criticism and disparagement.
24+
* Sustained disruptions.
25+
* Violence, threats of violence or violent language.
26+
27+
## Enforcement
28+
Understand that speech and actions have consequences, and unacceptable behavior will not be tolerated.
29+
30+
If you are the subject of, or witness to any violations of this Code of Conduct, please contact us by submitting a form [here](https://docs.google.com/a/slack-corp.com/forms/d/1NVqj2S2Q49XVIOT5N3L6Tx1oihvk9CpMa_UX8T_6ESo/viewform), or email [email protected].
31+
32+
If violations occur, organizers will take any action they deem appropriate for the infraction, up to and including expulsion.
33+
34+
_Thanks to the [Django Code of Conduct](https://www.djangoproject.com/conduct/), [The Citizen Code of Conduct](http://citizencodeofconduct.org/), [The Rust Code of Conduct](https://www.rust-lang.org/conduct.html) and [The Ada Initiative](http://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/)._

LICENSE.txt renamed to LICENSE

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015-2016 Slack Technologies, Inc
4+
15
Permission is hereby granted, free of charge, to any person obtaining a copy
26
of this software and associated documentation files (the "Software"), to deal
37
in the Software without restriction, including without limitation the rights

0 commit comments

Comments
 (0)