YunoHost/apps
1
0
Fork 0
mirror of https://github.com/YunoHost/apps.git synced 2024-09-03 20:06:07 +02:00
Code Projects Activity

Merge pull request #36 from Psycojoker/official_app_procedure

Browse source 
[doc] improve documentation regarding making an app official
This commit is contained in:
M5oul 2016-03-11 20:57:40 +01:00
commit 7e7f91d41b
1 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -54,12 +54,25 @@ App example addition:
}
```
#### How to add an app to the official list
#### How to propose your app to be integrated in the official applications list
Same steps than above, but on the `official.json` list with the status `validated`.
Integration will be discussed on the Pull Request.
Here is the procedure to request that your app will be part of the list of official applications of YunoHost:
**Important**: You will have to find a maintainer willing to take care of the package while published if you want your app to be validated.
* before everything, having you application joining the list of official applications will make you a maintainer of it and will requires you to ensure this position or to find someone else to do it in the future
* your app must be tested on several architectures (32/64 bits, ARM) or depends on cross-platform systems
* you must be subscribed to the [apps official mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) since this is the way that we communicate to apps maintainers
* your application must have the following scripts:
* a install script, obviously
* a remove script
* an upgrade script if needed
* a backup/restore script if your application stores data
* your application must be installable on a custom path (`domain.tld/custom_path/`) in addition to the root path
* if relevant, your application must be integrated with YunoHost SSO
* your application you have packaged must be free software
* once all those requirements are fulfilled, fork this repository, add your application to the official.json list with the status "validated" following the documentation above, then open a pull request
* we will then start a reviewing process and we will work together to bring your application to a state where we can hopefully include it to the official applications list :)
Since our documentation regarding all those part is not as complete as it should be, don't hesitate to ask questions on the [apps mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) regarding those points.
#### Helper script