From 38c888c14a638ac8d7e652b8a0cb4cf347bc707a Mon Sep 17 00:00:00 2001 From: Half-Shot Date: Mon, 9 Sep 2019 13:15:13 +0100 Subject: [PATCH] Add section about making changes --- docs/development_guide.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/development_guide.md b/docs/development_guide.md index c4d4e7fc..ee9534c4 100644 --- a/docs/development_guide.md +++ b/docs/development_guide.md @@ -103,4 +103,19 @@ and have built the typescript. To ensure that it's all working, you can run You can follow the instructions in the [README](../README.md) to generate and update the registration file, as well as creating a testing Slack app and workspace. You should enable RTM support in the config, as Slack will not be able to push events to your local bridge. -Make sure that you copy the generated registration file to `~/slack-bridge-env/synapse` and add an entry for it in the `homeserver.yaml` before starting the synapse container. \ No newline at end of file +Make sure that you copy the generated registration file to `~/slack-bridge-env/synapse` and add an entry for it in the `homeserver.yaml` before starting the synapse container. + +## Making changes + +Whenever you want to make changes to the codebase, you must: + +```bash +git fetch matrix-org +git checkout matrix-org/develop +git checkout -b yourfeaturname +npm i +``` + +You should always work within the `src` directory. It is helpful to have a code editor setup with linting enabled so you can see mistakes as you work. Always remember to run `npm run build` before commiting or testing so that you know the latest changes work. + +Before commiting your work, ensure that the tests pass locally with `npm test`. If you are making changes to packages, ensure that `package-lock.json` is included in the commit.