Skip to content

Commit 5d25881

Browse files
author
Ignacio Romero Zurbuchen
authored
Merge pull request slackhq#537 from slackhq/guidelines-fixes
Fixes broken links and missing Contributing.md file
2 parents 6bca712 + 0f232e8 commit 5d25881

File tree

3 files changed

+37
-4
lines changed

3 files changed

+37
-4
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
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).
1+
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackhq/SlackTextViewController/blob/master/.github/CONTRIBUTING.md) and have done my best effort to follow them.
2+
* [ ] I've read and agree to the [Code of Conduct](https://github.com/slackhq/SlackTextViewController/blob/master/.github/CODE_OF_CONDUCT.md).
33
* [ ] I've searched for any related issues and avoided creating a duplicate issue.
44

55
#### Description

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
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).
1+
* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackhq/SlackTextViewController/blob/master/.github/CONTRIBUTING.md) and have done my best effort to follow them.
2+
* [ ] I've read and agree to the [Code of Conduct](https://github.com/slackhq/SlackTextViewController/blob/master/.github/CODE_OF_CONDUCT.md).
33
* [ ] I've been mindful about doing atomic commits, adding documentation to my changes, not refactoring too much.
44
* [ ] 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).
55
* [ ] I've written tests to cover the new code and functionality included in this PR.

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/{project_name}/blob/master/README.md) and [the changelog](https://github.com/slackhq/{project_name}/blob/master/README.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/{project_name}/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/{project_name}/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/{project_name}) 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)

0 commit comments

Comments
 (0)