Skip to content

Latest commit

聽

History

History
30 lines (18 loc) 路 1.66 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) 路 1.66 KB
Raw

Contributing to REACT COOL STARTER

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Working on your first Pull Request? You can learn how from this free video series.

Pull Request Process

  1. Fork the repository and create your branch from master.
  2. Run yarn to install dependencies.
  3. If you鈥檝e fixed a bug or added code that should be tested.
  4. Ensure the test suite passes by running yarn test.
  5. Update the README.md with details of changes.
  6. Make sure your code lints by running yarn lint.

Development Workflow

After cloning REACT COOL STARTER, run yarn to fetch its dependencies. Then, you can run several commands.

Style Guide

We use ESLint, StyleLint and Prettier for code style and formatting. Run yarn lint after making any changes to the code. Then, our linter will catch most issues that may exist in your code.

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

License

By contributing to REACT COOL STARTER, you agree that your contributions will be licensed under its MIT license.