Adding a contribution guide, and an email contact.
This commit is contained in:
parent
0cc160240f
commit
98a9515a50
47
CONTRIBUTING.md
Normal file
47
CONTRIBUTING.md
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
# Welcome to the contributing guide for the plugin peertube-plugin-livechat
|
||||||
|
|
||||||
|
Interested in contributing? Awesome!
|
||||||
|
|
||||||
|
## Translate
|
||||||
|
|
||||||
|
You can help us to translate this PeerTube plugin by creating or modifying translation files in the `languages` folder.
|
||||||
|
|
||||||
|
Please work on the `develop` branch, and do your commits and pull request on this branch.
|
||||||
|
|
||||||
|
If the language you are interesting in does not exist yet, create a file `language_code.json` in the `languages` folder.
|
||||||
|
The language code must be the same as the Peertube's langage code (see [peertube documentation](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/translation.md)).
|
||||||
|
Then add the language file in the [package.json](package.json) file, under the key `translations`.
|
||||||
|
|
||||||
|
Translation strings are set in the language file as follow:
|
||||||
|
|
||||||
|
- files are in [json format](https://www.json.org)
|
||||||
|
- the key is the english string (see existing keys in the [french translation file](languages/fr.json)).
|
||||||
|
- the value is the translating string
|
||||||
|
- NB: there is no english translation file (this is how translation works for peertube's plugins)
|
||||||
|
|
||||||
|
## Give your feedback
|
||||||
|
|
||||||
|
You don't need to know how to code to start contributing to this plugin! Other
|
||||||
|
contributions are very valuable too, among which: you can test the software and
|
||||||
|
report bugs, you can give feedback on potential bugs, features that you are
|
||||||
|
interested in, user interface, design, decentralized architecture...
|
||||||
|
|
||||||
|
## Develop
|
||||||
|
|
||||||
|
Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
|
||||||
|
before you start working on it, and inform the community that you begin coding by claiming the issue.
|
||||||
|
|
||||||
|
Please use the `develop` branch. The `main` branch is reserved to released versions of the plugin, so that the documentation is always synchronized with the released version of the plugin.
|
||||||
|
Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
|
||||||
|
Once you are ready for a code review before merge, submit a Pull Request. In any case, please
|
||||||
|
link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
|
||||||
|
|
||||||
|
The front-end code is in the `client` folder, the back-end code in `server`. There are some shared code in `shared` folder.
|
||||||
|
|
||||||
|
For general instructions (developping plugins, building, installation, ...), please refer to the [Peertube documentation](https://docs.joinpeertube.org/contribute-plugins?id=write-a-plugintheme).
|
||||||
|
|
||||||
|
You can build the plugin with extra debug features simply by using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
NODE_ENV=dev npm run build
|
||||||
|
```
|
@ -23,6 +23,8 @@ If you are a webdesigner or a ConverseJS/Prosody/XMPP expert, and want to help i
|
|||||||
|
|
||||||
If you have any question, or if you want to talk about this plugin, you can join this XMPP room with any Jabber client: [plugin-livechat-support@room.im.yiny.org](xmpp:plugin-livechat-support@room.im.yiny.org?join).
|
If you have any question, or if you want to talk about this plugin, you can join this XMPP room with any Jabber client: [plugin-livechat-support@room.im.yiny.org](xmpp:plugin-livechat-support@room.im.yiny.org?join).
|
||||||
|
|
||||||
|
If you want to support the project financially, you can contact me by mail at git.[at].john-livingston.fr.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
|
|
||||||
For the chat mode, and related settings, please refer to the corresponding documentation:
|
For the chat mode, and related settings, please refer to the corresponding documentation:
|
||||||
@ -33,6 +35,10 @@ For the chat mode, and related settings, please refer to the corresponding docum
|
|||||||
|
|
||||||
There are several common settings. Please see the documentation here: [common settings documentation](documentation/common.md).
|
There are several common settings. Please see the documentation here: [common settings documentation](documentation/common.md).
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
Please refer to the page [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
Thanks to David Revoy for his work on Peertube's mascot, [Sepia](https://www.davidrevoy.com/index.php?tag/peertube).
|
Thanks to David Revoy for his work on Peertube's mascot, [Sepia](https://www.davidrevoy.com/index.php?tag/peertube).
|
||||||
|
Loading…
Reference in New Issue
Block a user