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/
This commit is contained in:
		
							parent
							
								
									7cbbb03a04
								
							
						
					
					
						commit
						3cd9b9a828
					
				
					 13 changed files with 124 additions and 0 deletions
				
			
		
							
								
								
									
										33
									
								
								.github/CONTRIBUTING.md
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								.github/CONTRIBUTING.md
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,33 @@ | |||
| # Contributing at Slack | ||||
| 
 | ||||
|  | ||||
| 
 | ||||
| ## Before Contributing | ||||
| 
 | ||||
| Before contributing, please read our [Code of Conduct](./CODE_OF_CONDUCT.md). We take it very seriously, and expect that you will as well. | ||||
| 
 | ||||
| ## New Issues | ||||
| 
 | ||||
| Before opening a new issue, please consider: | ||||
| 
 | ||||
|   - 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. | ||||
|   - Searching for any related issues and avoid creating duplicated issues. | ||||
|   - 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. | ||||
|   - Trying out the examples [provided in this repository](https://github.com/slackhq/python-rtmbot/tree/master/examples). | ||||
|   - 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. | ||||
|   - 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. | ||||
| 
 | ||||
| 
 | ||||
| ## New Pull Requests | ||||
| 
 | ||||
| We love pull requests and we are generally very receptive to contributions. Things to keep in mind: | ||||
| 
 | ||||
| - [Fork the repository](https://github.com/slackhq/python-rtmbot) and make sure to work on a branch up to date with origin master. | ||||
| - Do your thing! | ||||
| - Be mindful about doing atomic commits, adding documentation to your changes, not refactoring too much. | ||||
| - Add tests covering the new code or functionality you are adding. | ||||
| - 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). | ||||
| - 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_. | ||||
| - Create your pull request (yay!). If it is in relation to an existing issue, please mention it on the title or description. | ||||
| 
 | ||||
| [Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z) | ||||
							
								
								
									
										29
									
								
								.github/ISSUE_TEMPLATE.md
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								.github/ISSUE_TEMPLATE.md
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,29 @@ | |||
| * [ ] I've read and understood the [Contributing guidelines](./CONTRIBUTING.md) and have done my best effort to follow them. | ||||
| * [ ] I've read and agree to the [Code of Conduct](./CODE_OF_CONDUCT.md). | ||||
| * [ ] I've searched for any related issues and avoided creating a duplicate issue. | ||||
| 
 | ||||
| #### Description | ||||
| > e.g. Description of the bug or feature | ||||
| 
 | ||||
| #### Reproducible in: | ||||
| * [ ] This is reproducible in the sample project. | ||||
| RTMBot version: | ||||
| Python version: | ||||
| OS Version: | ||||
| 
 | ||||
| #### Steps to reproduce: | ||||
| 
 | ||||
| 1.  | ||||
| 2.  | ||||
| 3.  | ||||
| 
 | ||||
| ### Expected result: | ||||
| > e.g. What you expected to happen | ||||
| 
 | ||||
| ### Actual result: | ||||
| > e.g. What actually happened | ||||
| 
 | ||||
| ### Attachments: | ||||
| > e.g. Logs, screenshots, screencast, sample project, funny gif, etc. | ||||
| 
 | ||||
| 
 | ||||
							
								
								
									
										15
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,15 @@ | |||
| * [ ] I've read and understood the [Contributing guidelines](./CONTRIBUTING.md) and have done my best effort to follow them. | ||||
| * [ ] I've read and agree to the [Code of Conduct](./CODE_OF_CONDUCT.md). | ||||
| * [ ] I've been mindful about doing atomic commits, adding documentation to my changes, not refactoring too much. | ||||
| * [ ] 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). | ||||
| * [ ] I've written tests to cover the new code and functionality included in this PR. | ||||
| * [ ] 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). | ||||
| 
 | ||||
| #### PR Summary | ||||
| > e.g. New functionality for producing whatsits. | ||||
| 
 | ||||
| #### Related Issues | ||||
| > e.g. Fixes #206 and closes #230 | ||||
| 
 | ||||
| #### Test strategy | ||||
| > e.g. Add tests around whatsit production. | ||||
							
								
								
									
										
											BIN
										
									
								
								.github/contributing_header_slack.png
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								.github/contributing_header_slack.png
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 99 KiB | 
							
								
								
									
										9
									
								
								CHANGELOG.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								CHANGELOG.md
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,9 @@ | |||
| ### v0.2.0 (2016-03-25) | ||||
| 
 | ||||
|   * Fixed unicode handling to make things work in python 2.7 and 3.5. | ||||
|   * Changed versioning scheme to Semver. | ||||
| 
 | ||||
| ### v0.10 (2016-02-28) | ||||
| 
 | ||||
|   * Refactored the RTMBot Class to make it more isolated from the script that runs the bot | ||||
| 
 | ||||
							
								
								
									
										34
									
								
								CODE_OF_CONDUCT.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								CODE_OF_CONDUCT.md
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,34 @@ | |||
| # Slack open source 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. | ||||
| 
 | ||||
| ## Expected Behavior | ||||
|   * Be welcoming. | ||||
|   * Be kind. | ||||
|   * Look out for each other. | ||||
| 
 | ||||
| ## Unacceptable Behavior | ||||
|   * Conduct or speech which might be considered sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory or offensive in nature. | ||||
|   * Unwelcome, suggestive, derogatory or inappropriate nicknames or terms. | ||||
|   * Disrespect towards others. (Jokes, innuendo, dismissive attitudes.) | ||||
|   * Intimidation or harassment (online or in-person). Please read the [Citizen Code of Conduct](http://citizencodeofconduct.org/) for how we interpret harassment.  | ||||
|   * Disrespect towards differences of opinion. | ||||
|   * Inappropriate attention or contact. Be aware of how your actions affect others. If it makes someone uncomfortable, stop. | ||||
|   * Not understanding the differences between constructive criticism and disparagement. | ||||
|   * Sustained disruptions. | ||||
|   * Violence, threats of violence or violent language. | ||||
| 
 | ||||
| ## Enforcement  | ||||
| Understand that speech and actions have consequences, and unacceptable behavior will not be tolerated. | ||||
| 
 | ||||
| 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 conduct@slack.com. | ||||
| 
 | ||||
| If violations occur, organizers will take any action they deem appropriate for the infraction, up to and including expulsion. | ||||
| 
 | ||||
| _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/)._ | ||||
|  | @ -1,3 +1,7 @@ | |||
| The MIT License (MIT) | ||||
| 
 | ||||
| Copyright (c) 2015-2016 Slack Technologies, Inc | ||||
| 
 | ||||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||||
| of this software and associated documentation files (the "Software"), to deal | ||||
| in the Software without restriction, including without limitation the rights | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Jeff Ammons
						Jeff Ammons