Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

73 lines (42 loc) · 1.63 KB
Raw

Techbasejs

Found an issue?

  • Tag your issue with the tag bug
  • Provide a short summary of what you are trying to do
  • Provide the log of the encountered error if applicable
  • Provide the exact version of commitlint. Check npm ls [library] when in doubt
  • Be awesome and consider contributing a contribute

For contribute?

Please consider these guidelines when filling a pull request:

Coding Rules

  • Run pnpm prettier before create a pull request

Commit Rules

Source use commitlint for commit rules, you can follow the commit rules in the file commitlint.config.js

Environment setup

Required nodejs >= 18x & already installed pnpm

This project uses pnpm, so be sure that it is available in your shell environment.

After cloning the repo run:

pnpm install

A package already exists a folder playground for development, you can run pnpm play to starting a develop a package, if develop for react or vue library, you can run pnpm play:react or pnpm play:vue

Other scripts:

  • Linting a package: pnpm lint
  • Testing a package: pnpm test
  • Publish a package: pnpm release

Example for playground a package

pnpm --filter ./packages/simm-fetch run play

Publishing a release

Login into npmjs

npm login

Publish to npmjs

pnpm release

After release, a changelog file will be updated with current version of package, you need create a tag for github release.

Happy coding :)