From 356c976bb3fc7920313cb656917f206151a61e65 Mon Sep 17 00:00:00 2001 From: Nicholas Ray Date: Tue, 4 Feb 2020 22:32:22 -0700 Subject: [PATCH] Add Coding Conventions Section to Vector README Although the convention of where to put conventions remains somewhat contentious, the team's desired conventions for Desktop Improvments have so far been, for the most part, general and could be useful for any project our team owns (e.g. MobileFrontend, Minerva, etc). Therefore, I added/made revisions to the https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions wiki page as this seems the be the single source of truth of our team specific conventions that span across repos. This commit just links to these changes which follows the same pattern as Minerva and MobileFrontend. Additional Changes: * Added installation section similar to Minerva Skin Bug: T239269 Change-Id: I41c71fba1228086f1830d8bb0808227b62ebf5cd --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 85e6ff712..20982f330 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,28 @@ Vector Skin ======================== -Configuration options ---------------------- +Installation +------------ -### $wgVectorPrintLogo +See + +Development +----------- + +### Coding conventions + +We strive for compliance with MediaWiki conventions: + + + +Additions and deviations from those conventions that are more tailored to this +project are noted at: + + + +### Configuration options + +#### $wgVectorPrintLogo Logo used in print styles. Keys are `url`, `width`, and `height` (in pixels). Note that this solution only works correctly if the image