aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md26
1 files changed, 12 insertions, 14 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index b3847b8d7..bbf06c87f 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,12 @@ 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/Chocobozzz/PeerTube
67$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
68$ cd PeerTube 68$ cd PeerTube
69$ yarn install --pure-lockfile 69$ yarn install --pure-lockfile
70``` 70```
@@ -73,6 +73,12 @@ Note that development is done on the `develop` branch. If you want to hack on
73Peertube, you should switch to that branch. Also note that you have to repeat 73Peertube, you should switch to that branch. Also note that you have to repeat
74the `yarn install --pure-lockfile` command. 74the `yarn install --pure-lockfile` command.
75 75
76When you create a new branch you should also tell to use your repo for upload
77not default one. To do just do:
78```
79$ git push --set-upstream me <your branch name>
80```
81
76Then, create a postgres database and user with the values set in the 82Then, create a postgres database and user with the values set in the
77`config/default.yaml` file. For instance, if you do not change the values 83`config/default.yaml` file. For instance, if you do not change the values
78there, the following commands would create a new database called `peertube_dev` 84there, the following commands would create a new database called `peertube_dev`
@@ -101,7 +107,7 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click
101 107
102### Server side 108### Server side
103 109
104You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md). 110You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
105 111
106To develop on the server-side: 112To develop on the server-side:
107 113
@@ -115,8 +121,8 @@ restart.
115 121
116### Client side 122### Client side
117 123
118You can find a documentation of the server code/architecture 124You can find a documentation of the client code/architecture
119[here](/support/doc/development/client/code.md). 125[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
120 126
121 127
122To develop on the client side: 128To develop on the client side:
@@ -193,11 +199,3 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te
193 199
194Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. 200Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
195Note that only instance 2 has transcoding enabled. 201Note 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).