Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 1.18 KB
Raw

Contributing to matic.js

  1. Clone this repository to your local machine.
  2. Checkout new branch to start development git checkout -b <branch-name>.

Branch naming convention:

  • Feature - feat_custom_token
  • Release/Build - release_2.1 or v2.1
  • Fix/Bug - fix_unknown_token or fixes (if more than one)

Note: No strict convention while naming branch, but try to keep it meaningful for your team members to understand.

  1. Add files to be committed and then commit changes to your local machine git commit -m <commit-message>

Commit message convention:

  • Feature - feat: integrate token balances
  • Release/Build - chore: release v2.1 or chore: bump version to 2.1
  • Fix/Bug - fix: token balances or fix: token list, transfers (if more than one)

Note: Keep commit message meaningful for your team members to understand while reviewing merge/pull request.

  1. Push changes to remote repository git push origin <branch-name>

  2. Create a merge/pull request against master branch.

Note: Don't push changes to master branch directly. Write proper description of the changes while creating merge/pull request