|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thanks for contributing! Our community of developers is what put SmartThings on the map! |
| 4 | + |
| 5 | +## How can I contribute? |
| 6 | + |
| 7 | +### Improve documentation |
| 8 | + |
| 9 | +As a user of the SmartApp SDK, you're the perfect candidate to help us improve our documentation. Error fixes, typo corrections, better explanations, more examples, etc. Open issues for things that could be improved – anything. Even improvements to this document. |
| 10 | + |
| 11 | +### Give feedback on issues |
| 12 | + |
| 13 | +We're always looking for more opinions on discussions in the issue tracker. It's a good opportunity to influence the future direction of this SDK. |
| 14 | + |
| 15 | +### [Submitting an issue or feature request](/issues/new/choose) |
| 16 | + |
| 17 | +- Search the issue tracker before opening an issue |
| 18 | +- Ensure you're using the latest version |
| 19 | +- Use a clear and descriptive title |
| 20 | +- Include as much information as possible by filling out the issue template |
| 21 | +- The more time you put into an issue, the more we will |
| 22 | + |
| 23 | +### [Submitting a pull request](/compare) |
| 24 | + |
| 25 | +- Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work. |
| 26 | +- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a pull request as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a `[WIP]` prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need to make. |
| 27 | +- Don't include unrelated changes |
| 28 | +- New features should be accompanied with tests and documentation |
| 29 | +- Use a clear and descriptive title for the pull request and commits |
| 30 | +- Lint and test before submitting the pull request by running `$ npm test` |
| 31 | +- Write a convincing description of why we should land your pull request. Answer _why_ it's needed and provide use-cases. |
| 32 | +- Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) (not master) |
| 33 | +- You might be asked to do changes to your pull request. There's never a need to open another pull request – [just update the existing one.](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) |
| 34 | + |
| 35 | +## [Finding contributions to work on](labels/help%20wanted) |
| 36 | + |
| 37 | +Look at the existing issues for areas of contribution. Searching for issues labeled `help wanted` would be a great place to start. |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## More about SmartThings |
| 42 | + |
| 43 | +If you are not familiar with SmartThings, we have |
| 44 | +[extensive on-line documentation](https://smartthings.developer.samsung.com/develop/index.html). |
| 45 | + |
| 46 | +To create and manage your services and devices on SmartThings, create an account in the |
| 47 | +[developer workspace](https://devworkspace.developer.samsung.com/). |
| 48 | + |
| 49 | +The [SmartThings Community](https://community.smartthings.com/c/developers/) is a good place share and |
| 50 | +ask questions. |
| 51 | + |
| 52 | +There is also a [SmartThings reddit community](https://www.reddit.com/r/SmartThings/) where you |
| 53 | +can read and share information. |
| 54 | + |
| 55 | +## License and Copyright |
| 56 | + |
| 57 | +Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) |
| 58 | + |
| 59 | +Copyright 2019 SmartThings, Inc. |
0 commit comments