diff options
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 26 | ||||
-rw-r--r-- | .github/FUNDING.yml | 1 |
2 files changed, 13 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) |
62 | to install the dependencies. | 60 | to install the dependencies. |
63 | 61 | ||
64 | Then clone the sources and install node modules: | 62 | Fork the github repository, |
63 | and 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 | |||
73 | Peertube, you should switch to that branch. Also note that you have to repeat | 73 | Peertube, you should switch to that branch. Also note that you have to repeat |
74 | the `yarn install --pure-lockfile` command. | 74 | the `yarn install --pure-lockfile` command. |
75 | 75 | ||
76 | When you create a new branch you should also tell to use your repo for upload | ||
77 | not default one. To do just do: | ||
78 | ``` | ||
79 | $ git push --set-upstream me <your branch name> | ||
80 | ``` | ||
81 | |||
76 | Then, create a postgres database and user with the values set in the | 82 | Then, 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 |
78 | there, the following commands would create a new database called `peertube_dev` | 84 | there, 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 | ||
104 | You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md). | 110 | You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code). |
105 | 111 | ||
106 | To develop on the server-side: | 112 | To develop on the server-side: |
107 | 113 | ||
@@ -115,8 +121,8 @@ restart. | |||
115 | 121 | ||
116 | ### Client side | 122 | ### Client side |
117 | 123 | ||
118 | You can find a documentation of the server code/architecture | 124 | You 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 | ||
122 | To develop on the client side: | 128 | To develop on the client side: |
@@ -193,11 +199,3 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te | |||
193 | 199 | ||
194 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. | 200 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. |
195 | Note that only instance 2 has transcoding enabled. | 201 | Note that only instance 2 has transcoding enabled. |
196 | |||
197 | ### Troubleshooting | ||
198 | |||
199 | Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html). | ||
200 | |||
201 | ### Tutorials | ||
202 | |||
203 | 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). | ||
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..cece65761 --- /dev/null +++ b/.github/FUNDING.yml | |||
@@ -0,0 +1 @@ | |||
custom: https://framasoft.org/en/#soutenir | |||