Create a Development Survival Guide

element-hq / element-web

A glossy Matrix collaboration client for the web.

https://element.io

GNU Affero General Public License v3.0

11.21k stars 2k forks source link

Create a Development Survival Guide #18331

Open novocaine opened 3 years ago

novocaine commented 3 years ago

We have some barebones documentation in our README but it would be great to have some more depth material explaining how to get productive quickly.

For example:

How to setup common IDEs (e.g. VSCode, WebStorm) to work on the project - linting, debugging, running tests etc
How to work efficiently with the multiple repositories involved
Common errors and how to fix them

turt2live commented 3 years ago

A WebStorm tip: It'll probably get confused about the layers: explicitly running yarn build in each layer then excluding the build output directories manually will save your imports a little bit. It'll still probably screw up imports from the js-sdk though, so manually check that those are pointing at src rather than lib before committing (until we get rid of the horrid webpack hacks we have in place for sourcemap alignment)