Skip to main content

contribution

Installing

Installing all the dependencies :

yarn

Running server :

yarn start

Creating production build

yarn build

Git commit conventions

We at Heiphen follow gitmoji | An emoji guide for your commit messages for our git messages.

  1. Install VSCode Extension for gitmoji from : Gitmoji - Visual Studio Marketplace

  2. Use 1 emoji and a message in a commit ( :emoji: :message: )

    a. 💄 Update HomePage

    b. 💚 Fix error

    c. 📝Update documentation

  3. Push to a branch with name of your Jira issue as assigned. Example : HT-13 or HT-28

Some DO's and DON'Ts

✅ Push to your branch and make a PR to dev

❌Never push directly to dev

Some Coding Guidelines

  1. Include comments as you code for better understanding
  2. For formatting, we use Prettier · Opinionated Code Formatter. Make sure you format code and check linting before you push it by running the following command :
yarn format && yarn lint:check
  1. Follow casing as followed everywhere.