diff options
author | Chocobozzz <me@florianbigard.com> | 2019-02-11 11:52:34 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2019-02-11 11:52:34 +0100 |
commit | 88108880bbdba473cfe36ecbebc1c3c4f972e102 (patch) | |
tree | b242efb3b4f0d7e49d88f2d1f2063b5b3b0489c0 /.github | |
parent | 53a94c7cfa8368da4cd248d65df8346905938f0c (diff) | |
parent | 9b712a2017e4ab3cf12cd6bd58278905520159d0 (diff) | |
download | PeerTube-88108880bbdba473cfe36ecbebc1c3c4f972e102.tar.gz PeerTube-88108880bbdba473cfe36ecbebc1c3c4f972e102.tar.zst PeerTube-88108880bbdba473cfe36ecbebc1c3c4f972e102.zip |
Merge branch 'develop' into pr/1217
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4b352922e..b5d7ede72 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -1,14 +1,16 @@ | |||
1 | # Welcome to the contributing guide for PeerTube | 1 | # Welcome to the contributing guide for PeerTube |
2 | 2 | ||
3 | Interesting in contributing? Awesome! | 3 | Interested in contributing? Awesome! |
4 | 4 | ||
5 | **Quick Links:** | 5 | **This guide will present you the following contribution topics:** |
6 | 6 | ||
7 | * [Translate](#translate) | 7 | * [Translate](#translate) |
8 | * [Give your feedback](#give-your-feedback) | 8 | * [Give your feedback](#give-your-feedback) |
9 | * [Write documentation](#write-documentation) | 9 | * [Write documentation](#write-documentation) |
10 | * [Develop](#develop) | 10 | * [Develop](#develop) |
11 | 11 | * [Improve the website](#improve-the-website) | |
12 | * [Troubleshooting](#troubleshooting) | ||
13 | * [Tutorials](#tutorials) | ||
12 | 14 | ||
13 | ## Translate | 15 | ## Translate |
14 | 16 | ||
@@ -37,6 +39,15 @@ Some hints: | |||
37 | * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory | 39 | * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory |
38 | 40 | ||
39 | 41 | ||
42 | ## Improve the website | ||
43 | |||
44 | PeerTube's website is [joinpeertube.org](https://joinpeertube.org), where people can learn about the project and how it works – note that it is not a PeerTube instance, but rather the project's homepage. | ||
45 | |||
46 | You can help us improve it too! | ||
47 | |||
48 | It is not hosted on GitHub but on [Framasoft](https://framasoft.org/)'s own [GitLab](https://about.gitlab.com/) instance, [FramaGit](https://framagit.org): https://framagit.org/framasoft/peertube/joinpeertube | ||
49 | |||
50 | |||
40 | ## Develop | 51 | ## Develop |
41 | 52 | ||
42 | Don't hesitate to talk about features you want to develop by creating/commenting an issue | 53 | Don't hesitate to talk about features you want to develop by creating/commenting an issue |
@@ -122,7 +133,7 @@ and the web server is automatically restarted. | |||
122 | $ npm run dev | 133 | $ npm run dev |
123 | ``` | 134 | ``` |
124 | 135 | ||
125 | ### Federation | 136 | ### Testing the federation of PeerTube servers |
126 | 137 | ||
127 | Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. | 138 | Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. |
128 | Then, we can create the databases (if they don't already exist): | 139 | Then, we can create the databases (if they don't already exist): |
@@ -176,3 +187,11 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te | |||
176 | 187 | ||
177 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. | 188 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. |
178 | Note that only instance 2 has transcoding enabled. | 189 | Note that only instance 2 has transcoding enabled. |
190 | |||
191 | ### Troubleshooting | ||
192 | |||
193 | Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html). | ||
194 | |||
195 | ### Tutorials | ||
196 | |||
197 | Please check out the related section in the [development documentation](https://docs.joinpeertube.org/lang/en/devdocs/index.html#tutorials). Contribute tutorials at [framagit.org/framasoft/peertube/documentation](https://framagit.org/framasoft/peertube/documentation). | ||