Skip to content

Latest commit

 

History

History
110 lines (67 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

110 lines (67 loc) · 3.9 KB
Raw

Vue.js Contributing Guide

Hi! I’m really excited that you are interested in contributing to Vue.js. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Issue Reporting Guidelines

  • The issue list of this repo is exclusively for bug reports and feature requests. For simple questions, please use either Gitter or the official forum.

  • 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 repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.

  • It is recommended that you make a JSFiddle to demonstrate your issue. You could start with this template that already includes the latest version of Vue.

  • 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

  • Checkout a topic branch from dev and merge back against dev.

  • Work in the src folder and DO NOT checkin dist in the commits.

  • Squash the commit if there are too many small ones.

  • Follow the code style.

  • Make sure the default grunt task 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 and have it greenlighted 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.

Code Style

  • No semicolons unless necessary.

  • Follow JSDoc.

  • 2 spaces indentation.

  • multiple var declarations.

  • 1 space after function and function names.

  • 1 space between arguments, but not between parentheses.

  • Break long ternary conditionals like this:

    var a = superLongConditionalStatement
  ? 'yep'
  : 'nope'

  • When in doubt, read the source code.

Development Setup

You will need Node.js & Grunt.

$ npm install -g grunt-cli
$ npm install
# install pre-commit lint hook
$ npm run install-hook

Dev mode: watch and auto-build dist/vue.js and unit tests during development:

$ npm run dev

The unit tests can be run in a browser by opening test/unit/runner.html. Make sure you are running dev mode first. There's a shortcut grunt task for opening the unit test page:

$ grunt open

To lint:

$ grunt eslint

To build:

$ grunt build

Run full test suite (see browser notes below):

$ grunt test

The default task (by simply running grunt) will do the following: lint -> build -> unit tests -> e2e tests. It is required to have this pass successfully for a PR to be considered.

The unit tests are written with Jasmine and run with Karma. The e2e tests are written for and run with CasperJS.

Test Browser Notes

When running the default grunt task, the unit tests will automatically be run in Chrome, Firefox and Safari. If you are not on a Mac, or don't have one of the browsers installed on your system, you can modify the karma config in gruntfile.js to only run Karma tests in browsers that are available on your system. Just make sure don’t check in the gruntfile changes for the commit.