diff options
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r-- | .github/CONTRIBUTING.md | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7c480c52f..47129ea74 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -18,8 +18,10 @@ Interested in contributing? Awesome! | |||
18 | - [Server side](#server-side) | 18 | - [Server side](#server-side) |
19 | - [Client side](#client-side) | 19 | - [Client side](#client-side) |
20 | - [Client and server side](#client-and-server-side) | 20 | - [Client and server side](#client-and-server-side) |
21 | - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) | 21 | - [RTL layout](#rtl-layout) |
22 | - [Unit tests](#unit-tests) | 22 | - [Testing](#testing) |
23 | - [Unit tests](#unit-tests) | ||
24 | - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) | ||
23 | - [Emails](#emails) | 25 | - [Emails](#emails) |
24 | - [Plugins & Themes](#plugins--themes) | 26 | - [Plugins & Themes](#plugins--themes) |
25 | 27 | ||
@@ -163,6 +165,14 @@ and the web server is automatically restarted. | |||
163 | $ npm run dev | 165 | $ npm run dev |
164 | ``` | 166 | ``` |
165 | 167 | ||
168 | ### RTL layout | ||
169 | |||
170 | To test RTL layout using `ar` locale: | ||
171 | |||
172 | ``` | ||
173 | $ npm run dev -- --ar-locale | ||
174 | ``` | ||
175 | |||
166 | ### Testing | 176 | ### Testing |
167 | 177 | ||
168 | Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves | 178 | Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves |
@@ -216,14 +226,16 @@ $ createdb -O peertube peertube_test{1,2,3} | |||
216 | Build the application and flush the old tests data: | 226 | Build the application and flush the old tests data: |
217 | 227 | ||
218 | ``` | 228 | ``` |
219 | $ npm run build -- --light | 229 | $ npm run build |
220 | $ npm run clean:server:test | 230 | $ npm run clean:server:test |
221 | ``` | 231 | ``` |
222 | 232 | ||
223 | This will run 3 nodes: | 233 | To run 3 nodes: |
224 | 234 | ||
225 | ``` | 235 | ``` |
226 | $ npm run play | 236 | $ NODE_APP_INSTANCE=1 NODE_ENV=test npm start |
237 | $ NODE_APP_INSTANCE=2 NODE_ENV=test npm start | ||
238 | $ NODE_APP_INSTANCE=3 NODE_ENV=test npm start | ||
227 | ``` | 239 | ``` |
228 | 240 | ||
229 | Then you will get access to the three nodes at `http://localhost:900{1,2,3}` | 241 | Then you will get access to the three nodes at `http://localhost:900{1,2,3}` |