Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

86 lines (55 loc) · 1.64 KB

Getting Started

To contribute to Open UI, follow these steps:

  1. Fork the repository by clicking on the "Fork" button at the top right corner of the GitHub page.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/OpenLabs-dev/ui.git
    
  3. Create a new branch for your changes:

    git switch -c feat/my-feature
    
  4. Make the necessary changes and improvements to the codebase.

  5. Commit your changes with a descriptive commit message:

    git commit -m "feat: new feature"
    
  6. Push your changes to your forked repository:

    git push origin feat/my-feature
    
  7. Open a pull request (PR) on the original repository's GitHub page.

  8. Provide a clear and detailed description of your changes in the PR.

  9. Wait for the maintainers to review your changes and address any feedback or comments.

  10. Once your changes are approved, they will be merged into the main branch.

Thank you for your contribution to Open UI! We appreciate your support and look forward to your ideas and improvements.

Development

To start developing with Open UI, follow these steps:

  • Activate corepack
corepack enable pnpm
  • Install the necessary dependencies by running the following command in your terminal:

    pnpm install --frozen-lockfile
    

Built components

  1. Start the development to built components:

    pnpm compile
    

    Happy coding!

  2. Start playground

    pnpm dev:playground
    

Development documentation

  1. Start the development to docs:

    pnpm dev
    

    Happy coding!

  2. Start playground

    pnpm build-web