Skip to content

Latest commit

 

History

History
103 lines (66 loc) · 2.66 KB

contributing.md

File metadata and controls

103 lines (66 loc) · 2.66 KB

Contributing to WireUI

We welcome contributions from everyone, and are grateful for the time and effort spent by contributors. This document provides guidelines and steps for contributing to WireUI.

Table of Contents

Before You Start

  • Please ensure you have reviewed our documentation to familiarize yourself with the project.
  • If you encounter issues with any of our components, we encourage you to open a new issue. Before doing so, please check for existing issues to avoid duplicates and continue the discussion there if the issue has already been reported.
  • If you're planning to submit a pull request, kindly open a new issue detailing your plans to ensure we're not working on the same feature/bug fix. We're always excited to review and discuss your code!

Setting Up Your Environment

  1. Clone the repository and install dependencies:

    git clone [email protected]:wireui/wireui.git

cd wireui

composer install

yarn install

  2. Build assets:

    yarn build

    2.1 Watch and build assets:

    yarn build

  3. Running Tests:

    Make sure you have a chromium-based browser installed for running tests.

    yarn test

composer test

  4. Code Formatting: We adhere to a coding standard to maintain consistency. Before submitting your PR, ensure your code is formatted by running:

    yarn lint

composer pint

Working on a Local Project

  1. Create a new Laravel project:

    composer create-project laravel/laravel wireui-demo

cd wireui-demo

  2. Link local wireui into composer.json

    "repositories": {
    "local": {
        "type": "path",
        "url": "../path/to/wireui"
    }
}

  3. Install WireUI as a local dependency:

    composer require wireui/wireui

  4. Complete the setup:

    Follow the WireUI installation instructions to finish the setup.

  5. You're ready to contribute! 🎉

Submitting Your Contributions

Head over to the Pull Requests section in GitHub and create a new pull request.

Please provide a clear description of the changes you made, and reference any related issues.

We look forward to your contributions!