From f8ad281a7878fffec50df04ab6850d6b41978daf Mon Sep 17 00:00:00 2001 From: Laurent Peuch Date: Fri, 11 Mar 2016 16:50:04 +0100 Subject: [PATCH 1/3] [doc] improve documentation regarding making an app official --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c95421fc..1411f672 100644 --- a/README.md +++ b/README.md @@ -54,12 +54,18 @@ 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 crossplatform 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 at least a install, remove and upgrade (if this makes sens) scripts +* your applicaiton must be installable on a custom path (`domain.tld/custom_path/`) in addition to the root path +* 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 :) #### Helper script From ea59596e33f7cf36ab90806b5e4eb1685bbe520d Mon Sep 17 00:00:00 2001 From: Laurent Peuch Date: Fri, 11 Mar 2016 20:38:43 +0100 Subject: [PATCH 2/3] [doc] improve requirements list for becoming an official app --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1411f672..989bb07f 100644 --- a/README.md +++ b/README.md @@ -59,10 +59,15 @@ App example addition: Here is the procedure to request that your app will be part of the list of official applications of YunoHost: * 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 crossplatform systems +* 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 at least a install, remove and upgrade (if this makes sens) scripts -* your applicaiton must be installable on a custom path (`domain.tld/custom_path/`) in addition to the root path +* 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 :) From c0ceedc3830baeffe892322fb76874cadebd549d Mon Sep 17 00:00:00 2001 From: Laurent Peuch Date: Fri, 11 Mar 2016 20:44:49 +0100 Subject: [PATCH 3/3] [doc] point to mailing for inclear points --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 989bb07f..64ec88b3 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,8 @@ Here is the procedure to request that your app will be part of the list of offic * 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 You can use the add_or_update.py python script to add or update