diff options
author | Vijay A <vraravam@users.noreply.github.com> | 2021-10-30 13:18:07 +0530 |
---|---|---|
committer | Vijay A <vraravam@users.noreply.github.com> | 2021-10-30 13:18:07 +0530 |
commit | 24776db01d435ae963d44ece9420d2b2d65a3d39 (patch) | |
tree | 7b05ba7d1b569e7340b2b84bdc5b495b6329818e /CONTRIBUTING.md | |
parent | Fix some more documentation (diff) | |
download | ferdium-server-24776db01d435ae963d44ece9420d2b2d65a3d39.tar.gz ferdium-server-24776db01d435ae963d44ece9420d2b2d65a3d39.tar.zst ferdium-server-24776db01d435ae963d44ece9420d2b2d65a3d39.zip |
Fix some more documentation
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 2 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c326b8..a0b4c0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
@@ -17,6 +17,7 @@ | |||
17 | - [Git](#git) | 17 | - [Git](#git) |
18 | - [Clone repository with submodule](#clone-repository-with-submodule) | 18 | - [Clone repository with submodule](#clone-repository-with-submodule) |
19 | - [Install dependencies](#install-dependencies) | 19 | - [Install dependencies](#install-dependencies) |
20 | - [Start development app](#start-development-app) | ||
20 | - [Styleguide](#styleguide) | 21 | - [Styleguide](#styleguide) |
21 | - [Git Commit Messages format](#git-commit-messages-format) | 22 | - [Git Commit Messages format](#git-commit-messages-format) |
22 | - [Javascript Coding style-checker](#javascript-coding-style-checker) | 23 | - [Javascript Coding style-checker](#javascript-coding-style-checker) |
@@ -87,7 +88,7 @@ cd server | |||
87 | git submodule update --init --recursive | 88 | git submodule update --init --recursive |
88 | ``` | 89 | ``` |
89 | 90 | ||
90 | It is important you execute the last command to get the required submodules (recipes, server). | 91 | It is important you execute the last command to get the required submodules (recipes). |
91 | 92 | ||
92 | ### Install dependencies | 93 | ### Install dependencies |
93 | 94 | ||
@@ -122,14 +123,6 @@ node ace migration:refresh | |||
122 | 123 | ||
123 | - To get the full functionality, you will need to have an SMTP server running for local development. | 124 | - To get the full functionality, you will need to have an SMTP server running for local development. |
124 | 125 | ||
125 | <!-- ### Package recipe repository | ||
126 | |||
127 | Ferdi requires its recipes to be packaged before it can use it. When running Ferdi as a development instance, you'll need to package the local recipes before you can create any services inside Ferdi. | ||
128 | |||
129 | ```bash | ||
130 | cd recipes && npm i && npm run package | ||
131 | ``` --> | ||
132 | |||
133 | ### Start development app | 126 | ### Start development app |
134 | 127 | ||
135 | ```bash | 128 | ```bash |