1
0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-25 05:23:13 +03:00

Document ES6 changes

This commit is contained in:
Travis Ralston
2019-12-17 15:05:02 -07:00
parent 034b8db070
commit 14fb080f80

View File

@@ -36,8 +36,15 @@ minutes.
Code style Code style
~~~~~~~~~~ ~~~~~~~~~~
The code-style for matrix-js-sdk is not formally documented, but contributors The js-sdk aims to target TypeScript/ES6. All new files should be written in
are encouraged to read the code style document for matrix-react-sdk TypeScript and existing files should use ES6 principles where possible.
Members should not be exported as a default export - this is to prevent problems
down the line when importing various bits of code in other layers and in the
index for this project. In short, don't use `export default`.
The remaining code-style for matrix-js-sdk is not formally documented, but
contributors are encouraged to read the code style document for matrix-react-sdk
(`<https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md>`_) (`<https://github.com/matrix-org/matrix-react-sdk/blob/master/code_style.md>`_)
and follow the principles set out there. and follow the principles set out there.