CONTRIBUTING.md (3276B)
1 ## Contributing to React Starter Kit 2 3 React Starter Kit is currently the most widely adopted Node.js/React boilerplate used by many 4 tech startups around the globe. We're working hard to keep it up to date, making sure that it 5 follows best practices and high coding standards, paying extremely close attention to details. 6 7 Your contributions are welcome and are greatly appreciated! Every little bit helps, and credit 8 will always be given. 9 10 Please take a moment to review this document in order to make the contribution process easy and 11 effective for everyone involved. 12 13 ### Conduct 14 15 Please, follow the [golden rule](https://en.wikipedia.org/wiki/Golden_Rule). Be respectful, even to 16 those that are disrespectful. 17 18 ### Feedback 19 20 Feedback is the breakfast for champions! We'd love to hear your opinions, discuss potential 21 improvements, architecture, theory, internal implementation, etc. Please, join or start a new 22 conversation in our [issue tracker](https://github.com/kriasoft/react-starter-kit/issues), 23 [Gitter](https://gitter.im/kriasoft/react-starter-kit) chat room, or let's talk face-to-face on 24 [Appear.in](https://appear.in/react) or [Skype](http://hatscripts.com/addskype?koistya). 25 26 ### Documentation 27 28 We need your help with improving documentation to the project. This might be the easiest way for 29 you to contribute, because you don't even need to clone the repo but can edit or create new `.md` 30 files right from GitHub website as described [here](https://help.github.com/articles/editing-files-in-your-repository/). 31 32 ### Bugs & Feature Requests 33 34 Before opening an issue, please: 35 36 * Check the [Getting Started](https://github.com/kriasoft/react-starter-kit/blob/master/docs/getting-started.md) guide. 37 * Search the [issue tracker](https://github.com/kriasoft/react-starter-kit/issues) to make sure 38 your issue hasn’t already been reported. 39 * If your issue sounds more like a question, please post it on StackOverflow.com instead with the 40 tag [react-starter-kit](http://stackoverflow.com/questions/tagged/react-starter-kit). 41 42 ### Pull Requests 43 44 Before you submit a [pull request](https://help.github.com/articles/using-pull-requests/) from your 45 forked repo, check that it meets these guidelines: 46 47 * If the pull request adds functionality, the docs should be updated as part of the same PR. 48 * Create a separate PR for each small feature or bug fix. 49 * [Squash](http://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git) 50 your commits into one for each PR. 51 * Run `yarn test` to make sure that your code style is OK and there are no any regression bugs. 52 * When contributing to an opt-in feature, apply the `[feature/...]` tag as a prefix to your PR title 53 54 #### Style Guide 55 56 Our linter will catch most styling issues that may exist in your code. You can check the status 57 of your code styling by simply running: `yarn lint` 58 59 However, there are still some styles that the linter cannot pick up. If you are unsure about 60 something, looking at [Airbnb's Style Guide](https://github.com/airbnb/javascript) will guide you 61 in the right direction. 62 63 ### License 64 65 By contributing to React Starter Kit, you agree that your contributions will be licensed under its 66 [MIT license](https://github.com/kriasoft/react-starter-kit/blob/master/LICENSE.txt).