0.2.0 • Published 2 years ago
design-language-system v0.2.0
React Component Library
Getting Started
- Clone this repository -
git clone git@github.com:riyasavant/dls.git
cd dls
- Run
yarn
to install dependencies - Run the project -
yarn start
- Run storybook -
yarn storybook
Contributing
develop is the main branch which will contain stable versions of components, that can be deployed.
Steps
- Sync origin develop branch changes into local
- In develop branch -
git pull origin develop
- In develop branch -
- Create a new branch -
git branch <branch_name>
- Checkout to the new branch -
git checkout <branch_name>
- Create a dir inside src/components with the component name
- Write the code, styling and a story for the component
- Stage the changes -
git add .
- Commit the changes -
git commit -m "message"
- Push the changes
- If the branch is newly created locally -
git push --set-upstream origin <branch_name>
- For exisiting branches -
git push origin <branch_name>
- If the branch is newly created locally -
- Create a PR to the develop branch
Naming Guidelines for new Branches
- New component -
new/componentName
- Updating an existing component -
update/componentName
- Fixing fatal issues in existing components -
fix/componentName