Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

98 lines (68 loc) · 3.35 KB

Contributing

We're so excited you're interested in helping with Oku! We are happy to help you get started, even if you don't have any previous open-source experience 😊

New to Open Source?

  1. Take a look at How to Contribute to an Open Source Project on GitHub

Where to ask Questions?

  1. Check our Github Issues to see if someone has already answered your question.
  2. Join our community on Discord and feel free to ask us your questions

Prerequisites

  • [Min Nodejs 16] & PNPM installed
  • IDE: VSCode(recommended) or equivalent IDE

VScode Extensions

Note: What is Terminals Maganger and Commands -> oku-ui#34 (comment)

Project Setup

  1. Fork the oku-ui repository
  2. Install the project dependencies
    pnpm install
  3. Build the project
    pnpm build
  4. If new package vue, go to packages/example-package example packages/components or packages/core copy. You can copy this file and build your new build on it.
  5. Storybook works with the command pnpm dev

Scripts

pnpm build # Build all packages
pnpm build:components # Build components package
pnpm build:core # Build core package

pnpm dev # Run Storybook
pnpm build:storybook # Build Storybook

pnpm dev:all # Run all packages 
pnpm dev:components # Run components package
pnpm dev:core # Run core package

pnpm lint # Run ESLint
pnpm lint:fix # Run ESLint and fix errors

pnpm test # Run tests
pnpm test:watch # Run tests in watch mode
pnpm test testfilename # Run a specific test file name

pnpm play # Run the playground
pnpm play:vue # Run the playground with Vue
pnpm play:nuxt # Run the playground with Nuxt

pnpm clean: all # Clean all node_modules
pnpm clean:dist # Clean dist folder in all packages
pnpm clean:dts # Clean dts folder in all packages

Testing

  1. We use Vitest for testing
  2. To run the tests
    pnpm test
  3. Watch mode
    pnpm test:watch
  4. To run a specific test file name
    pnpm test testfilename

ESLint

  1. To run the linter
    pnpm lint
  2. All linting errors will be automatically fixed on commit pnpm lint:fix

Pull Request

  1. Before submitting a pull request make sure all tests have passed
  2. Reference the relevant issue or pull request and give a clear description of changes/features added when submitting a pull request
  3. Make sure the PR title follows conventional commits specification

Oku Community

Oku is made possible by a passionate team and a strong community of developers. If you have any questions or would like to get more involved in the Oku community you can check out: