If you are reading this, you rock 🎸 Thanks for showing interest in contributing to Sodium-UI and being part of the community. At Sodium UI we aim to make Open Source cake walk for the contributors and are always ready to assist you for all your queries. Here are some guidelines that will help you along the way.
Follow the below mentioned steps to setup the dev environment:
- Fork this Repository
- Clone your fork locally
git clone https://github.com/<your_github_username>/sodium-ui.git
cd sodium-ui- Install all the development dependencies for your project via npm.
npm install
- To visualize the UI components and to test the behaviour, Sodium-UI uses Storybook. To setup storybook, run
// using npm
npm run storybook
// or using yarn
yarn storybook
This will open Storybook at https://localhost:6006
- Once done with the changes, to test the working of the library, first bundle using rollup.js. Run
npm run build-sodium
- You can use
npm linkto test the library in your local machine. - After the appropriate testing and development of the feature/bug you resolved, feel free to make a PR. We will be happy to review it ASAP.
Note: Working on a remote branch is preferred for a particular feature/bug. Maintain Open Source Spirit and enjoy Open Sourcing ;)
Sodium-UI has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
By contributing your code to the sodium-ui GitHub repository, you agree to license your contribution under the MIT license.