You can contribute to the SundarUI by raising issues, reviewing code or submitting code. If you plan to make a contribution please do so through our detailed contribution workflow..
-
For every PR there should be an accompanying issue which the PR solves
-
The PR itself should only contain code which is the solution for the given issue
-
If you are a first time contributor check if there is a good first issue for you
-
Fork this repository to your own repository.
-
Clone the forked repository to your local machine.
-
Run it locally with our guide
-
Create your feature branch:
git checkout -b feature-my-new-feature -
Make changes to the project.
-
Commit your changes:
git commit -m 'Add some feature' -
Push to the branch:
git push origin feature-my-new-feature -
Submit a pull request :D
To install the project, navigate to the directory and run:
pnpm install
To run the project, run the following commands:
pnpm run docs:dev
By contributing your code, you agree to license your contribution under the terms of the MIT License license.