From 636526865d7fd44dbe7c45a4c1f2f2c2825f9a5c Mon Sep 17 00:00:00 2001 From: Yuri Timenkov Date: Sun, 11 Mar 2018 08:00:32 +0100 Subject: [PATCH] Minor devdocs improvement. Added devdocs to ToC. Moved note about developer reference to devdocs. Adjusted heading levels to show up properly in the ToC. --- docs/development.rst | 25 +++++++++++++++++-------- docs/index.rst | 6 +----- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index d94455df..215fc974 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -1,33 +1,42 @@ +How to Contribute +================= + +Developer Reference +------------------- + +Documentation for the code itself is kept within the code, and is extracted via +TypeDoc. See the developer reference documentation `here `_. + Building extension -================== +------------------ As with most VS Code extensions you need you need `Node.JS `_ installed. -The process if failry straightforward: +The process if fairly straightforward: 1. Install dependencies -.. code:: sh +.. code:: bash $ npm install 2. Compile the code: -.. code:: sh +.. code:: bash $ npm run compile Of course build command (as few others) is available as Visual Studio Code task. Coding guidelines -================= +----------------- Formatting ----------- +:::::::::: Code is formatted using ``clang-format``. It is recommended to install `Clang-Format extension `_. Linting -------- +::::::: We use tslint for linting our sources. You can run tslint across the sources by calling ``npm run lint`` from a terminal or command prompt. You can also run ``npm: lint`` as a Code task by pressing ``CMD+P`` (``CTRL+P`` on Windows) and entering ``task lint``. @@ -35,7 +44,7 @@ Warnings from tslint show up in the Errors and Warnings quick box and you can na To lint the source as you make changes you can install the `tslint extension `_. Style ------ +::::: * Use inline field initializers whenever possible. * Declare properties in constructor parameters lists, when possible. diff --git a/docs/index.rst b/docs/index.rst index 9d32c899..0fd0bb99 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,11 +19,7 @@ Contents: configuring -Developer Reference -=================== - -`Documentation for the code itself is kept within the code, and is extracted via -TypeDoc. See the developer reference documentation here `_. + development Indices and tables ==================