Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 2.46 KB
Raw

Contributing to VisualEditor

Thank you for helping us develop VisualEditor!

This document describes how to report bugs, set up your development environment, run tests, and build documentation. It also provides the coding conventions we use in the project.

Bug reports

Please report bugs to phabricator.wikimedia.org using the VisualEditor project.

Running tests

VisualEditor's build scripts use the Grunt task runner. To install it make sure you have node and npm installed, then run:

# Install Grunt command-line utility
$ npm install -g grunt-cli

# Install VisualEditor's dev dependencies
$ npm install

Set FIREFOX_BIN – you may wish to add this to your .bashrc or equivalent:

export FIREFOX_BIN=`which firefox`

To run the tests, use:

$ grunt test

For other grunt tasks, see:

$ grunt --help

To run the tests in a web browser, open tests/index.html.

Building documentation

VisualEditor uses jsdoc to process documentation comments embedded in the code. To build the documentation, you will need to run npm run doc.

VisualEditor Code Guidelines

We inherit the code structure (about whitespace, naming and comments) conventions from MediaWiki. See Manual:Coding conventions/JavaScript on mediawiki.org.

Git commit messages should follow the conventions described in https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines.

Documentation comments

In addition to the MediaWiki conventions for JavaScript documentation:

We have the following custom tags:

  • @until Text: Optional text.
  • @source Text
  • @context {Type} Optional text.
  • @fires name

They should be used in the order as they are described here. Here's a slightly more complete list indicating their order between the standard tags.

  • @property
  • @until Text: Optional text.
  • @source Text
  • @context {Type} Optional text.
  • @inheritable
  • @param
  • @fires name
  • @return

Adding a new JavaScript class

When a new JavaScript class is added, the file must be referenced in the build manifest before it can be used. Add the file to build/modules.json in visualEditor.core.build (or somewhere more specific), and then run grunt build.