aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md21
1 files changed, 6 insertions, 15 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index b3847b8d7..822449b3a 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -9,8 +9,6 @@ Interested in contributing? Awesome!
9 * [Write documentation](#write-documentation) 9 * [Write documentation](#write-documentation)
10 * [Develop](#develop) 10 * [Develop](#develop)
11 * [Improve the website](#improve-the-website) 11 * [Improve the website](#improve-the-website)
12 * [Troubleshooting](#troubleshooting)
13 * [Tutorials](#tutorials)
14 12
15## Translate 13## Translate
16 14
@@ -61,10 +59,11 @@ Make sure that you have followed
61[the steps](/support/doc/dependencies.md) 59[the steps](/support/doc/dependencies.md)
62to install the dependencies. 60to install the dependencies.
63 61
64Then clone the sources and install node modules: 62Fork the github repository,
63and then clone the sources and install node modules:
65 64
66``` 65```
67$ git clone https://github.com/Chocobozzz/PeerTube 66$ git clone https://github.com/YOUR_GITHUB_USERNAME/PeerTube
68$ cd PeerTube 67$ cd PeerTube
69$ yarn install --pure-lockfile 68$ yarn install --pure-lockfile
70``` 69```
@@ -101,7 +100,7 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click
101 100
102### Server side 101### Server side
103 102
104You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md). 103You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
105 104
106To develop on the server-side: 105To develop on the server-side:
107 106
@@ -115,8 +114,8 @@ restart.
115 114
116### Client side 115### Client side
117 116
118You can find a documentation of the server code/architecture 117You can find a documentation of the client code/architecture
119[here](/support/doc/development/client/code.md). 118[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
120 119
121 120
122To develop on the client side: 121To develop on the client side:
@@ -193,11 +192,3 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te
193 192
194Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. 193Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
195Note that only instance 2 has transcoding enabled. 194Note that only instance 2 has transcoding enabled.
196
197### Troubleshooting
198
199Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html).
200
201### Tutorials
202
203Please 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).