Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.22 KB
Raw

Submit a new issue only if you are sure it is a missing feature or a bug.

A quick guide for pull request

  1. Fork the repo and create a branch for your new feature or bug fix.

  2. Make sure build pass. Run: npm run build

  3. Make sure no lint error. Run: npm run lint

  4. Run unit tests to ensure all features work well. Run: npm test

  5. Please add at least one unit test if you are going to add new feature.

  6. Make sure charites command work well after installing globally. Run:

npm uninstall -g .
npm uninstall @unvt/charites
npm install -g
charites help

  1. Make sure you submit a change specific to exactly one issue. If you have ideas for multiple changes please create separate pull requests.

  2. Make sure update documentation under docs folder if your changes affect existing documents.

  3. Push to your fork and submit a pull request. A button should appear on your fork its github page afterwards.

Translation of charites documentation

Please join our charites-docs project in transifex from here. Welcome to translate documentations in other languages.