Vector-Local/README.md
Jon Robson b109e10cf3 End migration mode
Can be merged when database rows have been updated to
no longer use skin version.

* Drop migration code
* Drop skin version preference
* Drop default skin version and existing accounts skin version
* Move skin definitions into skin.json
* Repurpose SkinVector as an abstract class
* Update READMEs

Bug: T301930
Bug: T294995
Bug: T302627
Change-Id: I7454d8f1cfdef81e7f3df476d8ce86736b46fff2
2022-03-23 16:46:42 +00:00

54 lines
1.3 KiB
Markdown

Vector Skin
========================
Installation
------------
See <https://www.mediawiki.org/wiki/Skin:Vector>.
### Configuration options
See [skin.json](skin.json).
Development
-----------
### Node version
It is recommended to use [nvm](https://github.com/nvm-sh/nvm) to use the version of node defined
in `.nvmrc` during local development. This ensures consistency amongst development environments.
### Coding conventions
We strive for compliance with MediaWiki conventions:
<https://www.mediawiki.org/wiki/Manual:Coding_conventions>
Additions and deviations from those conventions that are more tailored to this
project are noted at:
<https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions>
### Pre-commit tests
A pre-commit hook is installed when executing `npm install`. By default, it runs
`npm test` which is useful for automatically validating everything that can be
in a reasonable amount of time. If you wish to defer these tests to be executed
by continuous integration only, set the `PRE_COMMIT` environment variable to `0`:
```bash
$ export PRE_COMMIT=0
$ git commit
```
Or more succinctly:
```bash
$ PRE_COMMIT=0 git commit
```
Skipping the pre-commit tests has no impact on Gerrit change identifier hooks.
### Hooks
See [hooks.txt](hooks.txt).