Skip to content

Latest commit

 

History

History
100 lines (81 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

100 lines (81 loc) · 4.03 KB

Contributing to daisyUI

daisyUI welcomes contributions from anyone willing to help 🤝

Reporting issues

  • Before opening a new issue, first search for existing issues to avoid duplications.
  • Provide detailed reports to make things easier for maintainers.
  • If there's a weird bug, please provide a reproduction repository on GitHub (or a CodePen page or Tailwind Play page)

Fixing existing issues

  • You can help by fixing existing issues
  • Don't work on issues assigned to others (to avoid duplicate efforts)
  • Before starting to work on an issue, please first add a comment and ask to get assigned to that issue. This way everyone will know you're working on that and it avoids duplicate efforts.
  • Commit messages must start with: fix: #1 [description] which 1 is the number of issue, so the issue will close automatically and it gets added to changelog file on a release.

Feature requests

  • If you have an idea to discuss with the community, please open a discussion
  • For feature requests, open a new issue
  • All feature requests may not fit this library and some may get rejected. Don't take it personally.

Pull requests

  • A pull request must fix an open issue assigned to you. If there's no issue, please create one first. If it's not assigned to you, please ask for it in the comments. This is for avoiding duplicate efforts.
  • Fixing typos doesn't need to be an issue. You can just open a pull request.
  • Fixing a mistake in document website doesn't need to be an issue. You can just open a pull request.

Contribute translations

Building on local

To build the daisyUI node package on local:

  1. [Fork and] clone the repo on local
  2. Install Bun if you don't have it:
  3. Install dependencies:
bun install
  1. Build daisyUI package:
bun run build
  1. Now you can use your local build of daisyUI in another local project by installing it as a dependency using Bun (or NPM, etc):
    In your own local project where you want to use daisyUI:
bun install /path/to/daisyui/packages/daisyui

To run the documentation site on local:

  1. [Fork and] clone the repo on local
  2. Install Bun if you don't have it:
  3. Install dependencies:
bun install
  1. Build daisyUI package:
bun run build
  1. Run the document site:
bun run dev

File structure

packages
├── daisyui //daisyUI package
│   ├── index.js //entry point
│   ├── functions
│   ├── src
│   │   ├── base
│   │   ├── components
│   │   ├── themes
│   │   ╰── utilities
│   ╰── // generated files
├── docs //documentation site
│   ╰── src
│       ├── routes
│       │   ╰── (routes)
│       │       ├── blog
│       │       ├── components //component docs
│       │       ├── docs //docs
│       │       ╰── ...
│       ╰── translations
╰── playground //playground site
    ╰── src
        ╰── components
            ╰── Component.astro // Where you can test things without committing