Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 1.61 KB

Contributing

Code Style

This project follows JavaScript Standard Style with a couple of tweaks. ESLint will report any style violations when tests are run or with yarn lint

Some style violations can automatically be fixed by running yarn fix

Commit Messages

Semantic commit messages are used:

feat: added feature x
Type Usage
ci Continuous Integration changes
chore Build scripts, no production code change
feat New feature/enhancement
fix Fix a bug for users - not build related issues
refactor Refactoring production code, optimisations
style Formatting changes, no code change
test Adding, refactoring or fixing tests

Requirements

  • git 2.0.0 or newer
  • node.js 10.0.0 or newer
  • yarn 1.0.0 or newer (optional)

Setup

  1. Fork this repo

  2. Clone your fork:

    git clone https://github.com/your-username/preferred-locale.git
    cd preferred-locale
  3. Create a feature branch:

    git checkout -b your-feature-name
  4. Install dependencies:

    yarn
    # or
    npm install
  5. Test changes

    yarn test
    # or
    npm test
    
  6. Commit changes:

    git commit -am 'feat: add feature name'
  7. Push changes:

    git push origin your-feature-name
  8. Open a pull request