aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-02-17 09:10:00 +0100
committerChocobozzz <me@florianbigard.com>2023-02-17 09:14:00 +0100
commitf11d8a838099f5d9a67759820d57d0da294377fe (patch)
treed6d20347fbe434ad67a1d1e37d64bd5449bd591e /.github/CONTRIBUTING.md
parent29ff7889637cd82c3c531bd5b085a23e7d463356 (diff)
downloadPeerTube-f11d8a838099f5d9a67759820d57d0da294377fe.tar.gz
PeerTube-f11d8a838099f5d9a67759820d57d0da294377fe.tar.zst
PeerTube-f11d8a838099f5d9a67759820d57d0da294377fe.zip
Update contributing guide
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md47
1 files changed, 44 insertions, 3 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index fcb803e25..59dbc6854 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -21,10 +21,16 @@ Interested in contributing? Awesome!
21 - [RTL layout](#rtl-layout) 21 - [RTL layout](#rtl-layout)
22 - [Testing](#testing) 22 - [Testing](#testing)
23 - [Unit/integration tests](#unitintegration-tests) 23 - [Unit/integration tests](#unitintegration-tests)
24 - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) 24 - [Play with a federation of PeerTube servers](#play-with-a-federation-of-peertube-servers)
25 - [Emails](#emails) 25 - [Emails](#emails)
26 - [OpenAPI documentation](#openapi-documentation) 26 - [OpenAPI documentation](#openapi-documentation)
27 - [Environment variables](#environment-variables) 27 - [Environment variables](#environment-variables)
28 - [Generate/pull translations](#generatepull-translations)
29 - [Release PeerTube](#release-peertube)
30 - [PeerTube packages](#peertube-packages)
31 - [CI](#ci)
32 - [Monitoring](#monitoring)
33 - [Test live stream](#test-live-stream)
28- [Plugins & Themes](#plugins--themes) 34- [Plugins & Themes](#plugins--themes)
29 35
30<!-- END doctoc generated TOC please keep comment here to allow auto update --> 36<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -182,7 +188,7 @@ $ npm run dev:embed
182 188
183### RTL layout 189### RTL layout
184 190
185To test RTL layout using `ar` locale: 191To test RTL (right-to-left) layout using `ar` locale:
186 192
187``` 193```
188$ npm run dev -- --ar-locale 194$ npm run dev -- --ar-locale
@@ -197,7 +203,7 @@ as expected and respect the syntax conventions. They will run upon PR submission
197 203
198See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally. 204See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
199 205
200#### Testing the federation of PeerTube servers 206#### Play with a federation of PeerTube servers
201 207
202Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. 208Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
203Then, we can create the databases (if they don't already exist): 209Then, we can create the databases (if they don't already exist):
@@ -255,6 +261,41 @@ Additionally to these ones, we provide some environment for dev/test purpose:
255 * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin) 261 * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin)
256 * `NODE_DB_LOG=false`: disable SQL request logging 262 * `NODE_DB_LOG=false`: disable SQL request logging
257 263
264### Generate/pull translations
265
266See the [dedicated documentation](/support/doc/development/localization.md) to update PeerTube translations from Weblate or to support a new locale.
267
268### Release PeerTube
269
270See the [dedicated documentation](/support/doc/development/release.md) to release a new version of PeerTube.
271
272### PeerTube packages
273
274This repository also contains other packages/libraries than PeerTube (embed API, PeerTube types...).
275You can see the list on the [dedicated documentation](/support/doc/development/lib.md).
276
277### CI
278
279PeerTube uses Github actions to run tests every time a commit is pushed or a PR is opened.
280You can find more information about these tasks on the [dedicated documentation](/support/doc/development/ci.md).
281
282### Monitoring
283
284You can check the content of the client bundle or benchmark the REST API.
285To do so, see the [dedicated documentation](/support/doc/development/monitoring.md).
286
287### Test live stream
288
289To easily test a live on PeerTube:
290 * Enable live support in web admin configuration
291 * Create a permanent live on the PeerTube instance
292 * Get the **RTMP URL** and the **Live stream key**
293 * Send the live to PeerTube using `ffmpeg` using a local video:
294
295```
296ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/live/{STREAM KEY}
297```
298
258## Plugins & Themes 299## Plugins & Themes
259 300
260See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins 301See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins