1.7.1 ā¢ Published 4 months ago
convenience-core v1.7.1
convenience-core
š„ Core Values
- Always write clean code
- Think before coding
- Code has heart
- Ready to teach each other
- Responsibility for work
- Actively discuss
š± Environment
- Node - v18.12.0
- Yarn v1
- VSCode
- Eslint plugin
- Prettier plugin
š APIs and Documentation
- Docs
- Config husky + commintLint
- Degit (clone template from git)
- Jenkins vs Github Action
- Networking
- Reference
- Storybook
š Code base Structure
.
āāā docs
āāā .storybook
āāā plugin
āāā scripts
āāā src
ā āāā packages
ā ā āāā (all components and hooks)
ā ā āāā utils.ts
ā āāā stories
ā āāā types
āāā styles
āāā components
āāā index.css
āāā tailwind.config.js
- src/lib/components: contains all React component that is used by the project
- src/lib/hooks: contains common/shared hooks
- Folder src/lib will be exported
src/stories: contains all storybook file
styles/components: contains all css style for components, which be used to parse to cjs file, which will be used to build tailwind plugin
- plugin folder: will be used to build tailwind plugin, for more information, please visit https://tailwindcss.com/docs/plugins
After completing the development, run:
yarn parse-css
to parse .css to .cjs file, Then, go to the 'plugin/index.cjs' file, import the component that you've just developed into addComponent section.
š Release new version
- Create Merge Request to
master
branch. The release branch will trigger CI/CD process after change (this action will public package). To release new version, you have to commit with prefix ( fix(pencil): , feat(pencil):, perf(pencil):, ...). More info: https://github.com/semantic-release/semantic-release - Create Merge Request to
release-storybook
branch. The release branch will trigger CI/CD process after change (this action will public storybook).
š Commit Rules
Must create commit follow below rules:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
Example:
feat: first commit
š¤ Branch Rules
Must create branch follow below rules:
- feat/
- feedback/
- hotfix/
- revert/
- reset/
- force/
- refactor/
- fix/