11b9e7fd2d
* Use unordered lists at the top level. These items have no inherent order, and any patch to remove an item would require renumbering all subsequent items. * Use consistent indentation Change-Id: Ied3768e9c53d7d1104b20711fb0213ba6b27a555 |
||
|---|---|---|
| .phan | ||
| doc | ||
| i18n | ||
| includes | ||
| resources | ||
| screenshots | ||
| skinStyles | ||
| tests | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitreview | ||
| .nvmrc | ||
| .phpcs.xml | ||
| .stylelintignore | ||
| .stylelintrc.json | ||
| .svgo.config.js | ||
| bundlesize.config.json | ||
| CODE_OF_CONDUCT.md | ||
| composer.json | ||
| COPYING | ||
| Doxyfile | ||
| jest.config.js | ||
| jest.setup.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| skin.json | ||
| tsconfig.json | ||
Vector Skin
Installation
See https://www.mediawiki.org/wiki/Skin:Vector.
Configuration options
See skin.json.
Also see configuration.md
Development
Node version
It is recommended to use 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:
$ export PRE_COMMIT=0
$ git commit
Or more succinctly:
$ PRE_COMMIT=0 git commit
Skipping the pre-commit tests has no impact on Gerrit change identifier hooks.
Hooks
See hooks.txt.