Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

88 lines (57 loc) · 2.75 KB
Raw

fluent-vue Contributing Guide

General Guidelines

English is used as the common language to communicate with Maintainers. If description of issue / PR are written in non-English languages, those may be closed.

Issue Reporting Guidelines

  • Try to search for your issue, it may have already been answered or even fixed in the development branch.

  • Check if the issue is reproducible with the latest stable version of Vue. If you are using a pre-release, please indicate the specific version you are using.

  • It is required that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear reproduction steps may be closed. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.

  • For bugs that involves build setups, you can create a reproduction repository with steps in the README file.

  • If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

Pull Request Guidelines

  • Make sure pnpm test passes. (see development setup)

  • If adding new feature:

    • Add accompanying test case.

    • Provide convincing reason to add this feature. Ideally you should open a suggestion issue first to discuss with the Maintainers/Community before working on it.

  • If fixing a bug:

    • Provide detailed description of the bug in the PR. Live demo preferred.

    • Add appropriate test coverage if applicable.

Work Step Example

  • Fork the repository

  • Create your topic branch from main:

    git branch my-new-topic origin/main

  • Write new code and relevant tests

  • Run test and lint scripts

  • Commit your changes: git commit -am 'add feature X'

  • Push to the branch: git push origin my-new-topic

  • Submit a pull request to main branch of repository

Development Setup

You will need Node.js and pnpm and the code base is mainly written in TypeScript

After cloning the repo, run:

pnpm install

Commonly used NPM scripts

# lint source codes
$ pnpm lint

# run unit tests with vitest
$ pnpm test

# watch and run tests
$ pnpm test:watch

# build all dist files
$ pnpm build

There are some other scripts available in the scripts section of the package.json file.