Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 2.17 KB
Raw

Contributing

To fork or not to fork

If you want to change a simple thing, for example, fix a typo or update copy, feel free to use the GitHub web interface, that's perfect. Under the hood, it will do complex things but you don't need to think about it!

Style

For formatting and code style, we use Prettier and ESLint. Before committing, please run:

  • npm run prettier:write
  • npm run lint:fix

For the long run, we suggest to integrate these tools in your favorite code editor:

Commit convention

Your commit messages should conform to the Conventional Commits specification.

To help you follow this convention, this project is using commitizen. To use it:

  1. run git add first to add your changes to Git staging area
  2. use npm run commit to commit

Note: it's not mandatory to always commit with this tool (we don't), but it's great to get introduced to the commit conventions.

Git guidelines

We do aim having a clean Git history! When submitting a Pull Request, make sure:

  • each commit make sense and have a self-explaining message
  • there is no unnecessary commits (such as "typo", "fix", "fix again", "eslint", "eslint again" or merge commits)

Some tips to keep a clean Git history while working on your feature branch:

  • always update from master with git pull --rebase origin master or similar
  • you might have to git push origin --force, that's all right if you're the only one working on the feature branch
  • git commit --amend to modify your last commit with "fix", "typo", "prettier" or "eslint" modifications
  • git rebase --interactive to rewrite the history

We understand Git is not always easy for everyone and want to be inclusive. If it's difficult for you to submit a Pull request with a clean Git history, that's all right, we can always squash and merge it.