Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.4 KB

Contributing.md

File metadata and controls

38 lines (24 loc) · 1.4 KB

How to contribute

I love pull requests. And following this guidelines will make your pull request easier to merge.

Use GitHub interface for simple changes, otherwise follow the steps below.

Prerequisites

  • If it’s your first pull request, watch this amazing course by Kent C. Dodds.
  • Install EditorConfig plugin for your code editor to make sure it uses correct settings.
  • Fork the repository and clone your fork.
  • Install dependencies: npm install.

Development workflow

Run dev server (it will refresh the page after any changes in JS, styles or content):

npm start

Run linters and format code:

npm test

Please update npm lock file (package-lock.json) if you add or update dependencies.

Writing style

When you change content, please follow the writing style guide to ensure consistent style and formatting.

Other notes

  • If you have commit access to repository and want to make big change or not sure about something, make a new branch and open pull request.
  • We’re using Prettier to format code, so don’t worry much about code formatting.
  • Don’t commit generated files, like minified JavaScript.