Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

95 lines (59 loc) · 2.22 KB

Contributing Guide

Almin uses Yarn for running development scripts. If you haven't already done so, please install yarn.

Environment

  • Node.js >= 6.0.0
  • Yarn

Bootstrap

First, you should install all dependencies by following:

# In project root
yarn install

Almin repository is monorepo top on lerna. postinstall life-cycle script automatically run yarn run bootstrap that install all deps/devDeps.

How to contribute?

You can find suitable issues to contribute on Issues label:starter.

Of course, welcome to fix the other issue or file issue.

Basic Pull Request steps:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

How to run tests?

Run all tests that includes examples in Node.js:

yarn test
# It includes unit test/example test

You can only run unit test:

cd packages/almin && yarn test
# or
yarn test -- --scope almin

Run unit tests in Browser:

cd packages/almin && yarn run test:browser

How to fix document?

Contribute to documents without docs/api

  1. Fix the issue
  2. Preview documents
yarn run start:docs # preview

Welcome to fix documents!

Contribute to API Reference docs/api

API Reference is automatically generated from source code(`/src/*.ts``)

  1. Fix the comment of source code
  2. Build API Reference
yarn run build:docs:api # build
yarn run start:docs # preview

How to write document?

  1. Add Markdown document to docs/ directory.
  2. Add link to SUMMARY.md

How to write git commit message

Almin has adopted Conventional Commits

Conventional Commits

How to release?

Run following commands:

yarn test
yarn run publish