LightVue Contribution Guide

Thank you for CONTRIBUTING!

Raising an Issue

Make sure the issue hasn't been raised yet
The issue list of this repo is exclusively for Bug Reports and Feature Requests.
Bug reproductions should be as concise as possible.
Search for your issue, it may have been answered.
Include screenshots or animated GIFs in your issue whenever needed (if visual issue)

Always work on a new branch. Making changes on your fork's dev or master branch can cause problems. (See The beginner's guide to contributing to a GitHub project)
The master branch is a snapshot of the latest release. Submit your PR in the dev branch
It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging
Include screenshots or animated GIFs in your pull request whenever needed (if visual changes)
Bug fixes should be submitted to the master branch.
New features and breaking changes should be submitted to the dev branch.
Use a descriptive title no more than 64 characters long. This will be used as the commit message when your PR is merged.
For changes and feature requests, please include an example of what you are trying to solve and an example of the markup. It is preferred that you create an issue first however, as that will allow the team to review your proposal before you start.
Please reference the issue # that the PR resolves, something like Fixes #1234 or Resolves #6458 (See closing issues using keywords)
If adding new feature:
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it

Keep it simple.
UI needs to be compatible with Desktop & Mobile devices both.
It should support Vue2 and Vue3 with absolute no API change.
Performance directly affects the UX, keep it as lightweight as possible.
Avoid any other external dependency
Avoid HTML-only components, if it doesn't need JavaScript, then it doesn't need Vue (with a few exceptions).

Add comments if method is too complex and/or whenever you judge necessary.

# Clone this repository
git clone https://github.com/lightvue/lightvue

# From the project's root folder, install the dependencies
npm install

Vue 2.x Docs:

# Navigate to `docs/` (from the root)
cd ./docs

# Install dependencies for Vue 2.x
npm install

# Serve docs with hot reload
npm run dev

Vue 3.x Docs:

# Navigate to `docs-v3/` (from the root)
cd ./docs-v3

# Install dependencies for Vue 3
npm install

# Serve with hot reload
npm run dev