Skip to main content

Contributing 🙌

You are awesome for looking into contribute to Duck-UI! Your contributions are essential for us. Whether you are fixing a bug, creating a new feature, or improving documentation, we appreciate your effort. This guide will help you get started.

How to Contribute​

Reporting Bugs​

  • If you find a bug, please create an issue in our GitHub repository
    • Make sure you include:
      1. A clear title describing the bug.
      2. Steps to reproduce the issue.
      3. Expected vs. actual behavior.
      4. Any relevant error messages or logs.

Requesting Features​

  • Have an idea for a new feature? Great! Create a new feature request with the following details:
    • Make sure you include:
      1. A clear description of the feature.
      2. Why it’s needed or how it improves Duck-UI.
      3. Any additional context or mockups if available.

Improving Documentation​

Who in the world doesn't want a good documentation!? If you find typos, missing information, or want to expand a section, feel free to submit a pull request.

Code Contributions​

To contribute code, follow these steps:

  1. Fork the repository to your GitHub account.

    Alternatively, you can clone the repository directly:

    git clone https://github.com/caioricciuti/duck-ui.git
    cd duck-ui

  2. Create a new branch for your contribution:

    git checkout -b feature/my-new-feature

  3. Write your code and commit your changes:

    git commit -m "Add new feature"

  4. Push to your fork and open a Pull Request:

    git push origin feature/my-new-feature

  5. Open a pull request from your fork's branch to main on the Duck-UI repository.

Setting Up the Development Environment​

Before you start contributing, set up the local environment:

  1. Clone the repository:

    git clone https://github.com/your-org/duck-ui.git
    cd duck-ui

  2. Install dependencies and start the development server:

    npm install
    npm run dev

  3. Access the app locally at http://localhost:5173.

Code Style Guidelines​

To maintain consistency:

  • Follow the existing code patterns.
  • Ensure your code is well-documented with comments where necessary.
  • Run npm run lint to check for linting errors.

Testing​

  1. Write tests for any new features.

Community and Support​

If you need help or want to discuss a contribution idea, feel free to join our Slack channel. We also welcome discussions through GitHub Issues or Discussions.

License​

By contributing to Duck-UI, you agree that your contributions will be licensed under the same license as Duck-UI. Check the LICENSE file for more information.

Thank You!​

Thank you for being part of the Duck-UI community. Together, we can build something incredible! ❤️