Minor devdocs improvement.
Added devdocs to ToC. Moved note about developer reference to devdocs. Adjusted heading levels to show up properly in the ToC.
This commit is contained in:
Родитель
ed0c92046f
Коммит
636526865d
|
@ -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 <dev/index.html>`_.
|
||||
|
||||
Building extension
|
||||
==================
|
||||
------------------
|
||||
As with most VS Code extensions you need you need `Node.JS <https://nodejs.org/en/>`_ 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 <https://marketplace.visualstudio.com/items?itemName=xaver.clang-format>`_.
|
||||
|
||||
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 <https://marketplace.visualstudio.com/items/eg2.tslint>`_.
|
||||
|
||||
Style
|
||||
-----
|
||||
:::::
|
||||
|
||||
* Use inline field initializers whenever possible.
|
||||
* Declare properties in constructor parameters lists, when possible.
|
||||
|
|
|
@ -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 <dev/index.html>`_.
|
||||
development
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
Загрузка…
Ссылка в новой задаче