Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 3.2 KB
Raw

Contributing to React Starter Kit

React Starter Kit is currently the most widely adopted Node.js/React boilerplate used by many tech startups around the globe. We're working hard to keep it up to date, making sure that it follows best practices and high coding standards, paying extremely close attention to details.

Your contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Conduct

Please, follow the golden rule. Be respectful, even to those that are disrespectful.

Feedback

Feedback is the breakfast for champions! We'd love to hear your opinions, discuss potential improvements, architecture, theory, internal implementation, etc. Please, join or start a new conversation in our issue tracker, Gitter chat room, or let's talk face-to-face on Appear.in or Skype.

Documentation

We need your help with improving documentation to the project. This might be the easiest way for you to contribute, because you don't even need to clone the repo but can edit or create new .md files right from GitHub website as described here.

Bugs & Feature Requests

Before opening an issue, please:

  • Check the Getting Started guide.
  • Search the issue tracker to make sure your issue hasn’t already been reported.
  • If your issue sounds more like a question, please post it on StackOverflow.com instead with the tag react-starter-kit.

Pull Requests

Before you submit a pull request from your forked repo, check that it meets these guidelines:

  • If the pull request adds functionality, the docs should be updated as part of the same PR.
  • Create a separate PR for each small feature or bug fix.
  • Squash your commits into one for each PR.
  • Run yarn test to make sure that your code style is OK and there are no any regression bugs.
  • When contributing to an opt-in feature, apply the [feature/...] tag as a prefix to your PR title

Style Guide

Our linter will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running: yarn lint

However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at Airbnb's Style Guide will guide you in the right direction.

License

By contributing to React Starter Kit, you agree that your contributions will be licensed under its MIT license.