diff options
author | Chocobozzz <me@florianbigard.com> | 2021-06-25 14:55:25 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2021-06-25 14:55:25 +0200 |
commit | 4f97f58383c37d11a8f8ae3ef6e2b761307cb4d0 (patch) | |
tree | 81464f0a1d9e3753e1e7aeed125fc121eb7c5560 | |
parent | 37a44fc915eef2140e22ceb96aba6b6eb2509007 (diff) | |
download | PeerTube-4f97f58383c37d11a8f8ae3ef6e2b761307cb4d0.tar.gz PeerTube-4f97f58383c37d11a8f8ae3ef6e2b761307cb4d0.tar.zst PeerTube-4f97f58383c37d11a8f8ae3ef6e2b761307cb4d0.zip |
Update PR template and contributing guide
-rw-r--r-- | .github/CONTRIBUTING.md | 14 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 18 |
2 files changed, 14 insertions, 18 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a37159fa8..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 | ||
@@ -224,14 +226,16 @@ $ createdb -O peertube peertube_test{1,2,3} | |||
224 | Build the application and flush the old tests data: | 226 | Build the application and flush the old tests data: |
225 | 227 | ||
226 | ``` | 228 | ``` |
227 | $ npm run build -- --light | 229 | $ npm run build |
228 | $ npm run clean:server:test | 230 | $ npm run clean:server:test |
229 | ``` | 231 | ``` |
230 | 232 | ||
231 | This will run 3 nodes: | 233 | To run 3 nodes: |
232 | 234 | ||
233 | ``` | 235 | ``` |
234 | $ 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 | ||
235 | ``` | 239 | ``` |
236 | 240 | ||
237 | 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}` |
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a49db848f..3c96818a3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md | |||
@@ -6,24 +6,16 @@ | |||
6 | 6 | ||
7 | <!-- If suggesting a new feature or change, please discuss it in an issue first --> | 7 | <!-- If suggesting a new feature or change, please discuss it in an issue first --> |
8 | <!-- If fixing a bug, there should be an issue describing it with steps to reproduce --> | 8 | <!-- If fixing a bug, there should be an issue describing it with steps to reproduce --> |
9 | <!-- start with closing keywords if any apply: https://docs.github.com/en/enterprise/2.16/user/github/managing-your-work-on-github/closing-issues-using-keywords --> | ||
10 | 9 | ||
11 | ## Has this been tested? | 10 | ## Has this been tested? |
12 | 11 | ||
13 | <!--- Put an `x` in the box that applies: --> | 12 | <!-- Put an `x` in the box that applies: --> |
13 | <!-- Check the unit test guide: https://docs.joinpeertube.org/contribute-getting-started?id=unit-tests --> | ||
14 | |||
14 | - [ ] 👍 yes, I added tests to the test suite | 15 | - [ ] 👍 yes, I added tests to the test suite |
15 | - [ ] 👍 yes, light tests as follows are enough | ||
16 | - [ ] 💭 no, because this PR is a draft and still needs work | 16 | - [ ] 💭 no, because this PR is a draft and still needs work |
17 | - [ ] 🙅 no, because they aren't needed | 17 | - [ ] 🙅 no, because this PR does not update server code |
18 | - [ ] 🙋 no, because I need help | 18 | - [ ] 🙋 no, because I need help <!-- Detail how we can help you > |
19 | |||
20 | <!-- | ||
21 | If you didn't test via unit-testing, you will still be asked to prove your fix is effective, doesn't have side-effects, or that your feature simply works: | ||
22 | |||
23 | Please describe the tests that you ran to verify your changes. | ||
24 | Provide instructions so we can reproduce. | ||
25 | Please also list any relevant details for your test configuration(s): | ||
26 | --> | ||
27 | 19 | ||
28 | ## Screenshots | 20 | ## Screenshots |
29 | 21 | ||