From 2029264b74902926f6afa5f54d4bd7ca64b3d467 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Tue, 26 Feb 2019 17:43:30 +0100 Subject: [PATCH 1/3] Add YEP 1.12 - Follow example_ynh --- packaging_apps_guidelines.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packaging_apps_guidelines.md b/packaging_apps_guidelines.md index 19ee3aa0..d0d3cab6 100644 --- a/packaging_apps_guidelines.md +++ b/packaging_apps_guidelines.md @@ -32,6 +32,7 @@ Each YEP is associated with: | YEP 1.9 | Document the app | validated | AUTO | OFFICIAL (6) | | YEP 1.10 | Keep a clean version history | draft | manual | OFFICIAL (6) | | YEP 1.11 | Add app to [YunoHost bugtracker](https://github.com/YunoHost/issues/issues) | draft | manual | OFFICIAL (NA) | +| YEP 1.12 | Follow the template from [example_ynh](https://github.com/YunoHost/example_ynh) | draft | manual | OFFICIAL (8) | | | | | | | | ** YEP 2 ** | ** Stabilize an app ** | ** Status ** | ** Test ** | ** Level ** | | YEP 2.1 | Respect the manifest format | validated | Home | INPROGRESS (5) | @@ -209,6 +210,13 @@ There is also README.md, which must and can contain: #### YEP 1.11 ##### Add app to [YunoHost bugtracker](https://github.com/YunoHost/issues/issues) | draft | manual | OFFICIAL | +#### YEP 1.12 +##### Follow the template from [example_ynh](https://github.com/YunoHost/example_ynh) | draft | manual | OFFICIAL | +In order to facilitate the work of the community regarding a package, it has to follow the template shown by the example app. +This will help other packagers to read, modified and debug the package. Also, it will help to prolong the life of the package by giving it a standard template that other packagers will be able to quickly understand in case a package become orphan. +As well, a package should not use exotic or uselessly complicated code if it's not really needed. If so, this part of the code should be clearly documented. +Keep your code as easy as possible, keep everything a script needs directly into it. Do not move functions in another file. Keep it simple and efficient. + ### YEP 2 #### Stabilize an app #### YEP 2.1 From 7037b54fc67afbded7774e463d2a0d7fa9a8c13d Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Tue, 26 Feb 2019 17:46:13 +0100 Subject: [PATCH 2/3] Update packaging_apps_guidelines_fr.md --- packaging_apps_guidelines_fr.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packaging_apps_guidelines_fr.md b/packaging_apps_guidelines_fr.md index 4874d410..2298b5ce 100644 --- a/packaging_apps_guidelines_fr.md +++ b/packaging_apps_guidelines_fr.md @@ -32,6 +32,7 @@ Chaque YEP est associée à : | YEP 1.9 | Documenter l'app | validé | AUTO | OFFICIAL (6) | | YEP 1.10 | Garder un historique de version propre | brouillon | manuel | OFFICIAL (6) | | YEP 1.11 | Ajouter l'app au [bugtracker YunoHost](https://github.com/yunohost/issues/issues) | brouillon | manuel | OFFICIAL (NA) | +| YEP 1.12 | Suivre le modèle de [example_ynh](https://github.com/YunoHost/example_ynh) | brouillon | manuel | OFFICIAL (8) | | | | | | | | **YEP 2** | **Stabiliser une app** | **Statut** | **Test** | **Niveau** | | YEP 2.1 | Respecter le format du manifeste | validé | auto | INPROGRESS (5) | @@ -210,6 +211,13 @@ Il y a également le README.md, ce dernier doit et peut contenir : #### YEP 1.11 ##### Ajouter l'app au [bugtracker YunoHost](https://github.com/yunohost/issues/issues) | brouillon | manuel | OFFICIAL | +#### YEP 1.12 +##### Suivre le modèle de [example_ynh](https://github.com/YunoHost/example_ynh) | brouillon | manuel | OFFICIAL | +Afin de faciliter le travail de la communauté concernant un package, il doit suivre le modèle montré par l'application d'exemple. +Cela aidera les autres packagers à lire, modifier et débugger le paquet. De plus, cela aidera à prolonger la durée de vie du package en lui donnant un modèle standard que les autres packagers seront en mesure de comprendre rapidement au cas où un package deviendrait orphelin. +De plus, un package ne devrait pas utiliser de code exotique ou inutilement compliqué si ce n'est pas vraiment nécessaire. Le cas échéant, cette partie du code devrait être clairement documentée. +Gardez votre code aussi simple que possible, gardez tout ce dont un script a besoin directement dedans. Ne déplacez pas les fonctions dans un autre fichier. Restez simple et efficace. + ### YEP 2 #### Stabiliser une app #### YEP 2.1 From 044d4f7d611297d2e1f8cdb5a74ab8b260374c8e Mon Sep 17 00:00:00 2001 From: JimboJoe Date: Sat, 9 Mar 2019 15:23:30 +0100 Subject: [PATCH 3/3] Update packaging_apps_guidelines.md Co-Authored-By: maniackcrudelis --- packaging_apps_guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packaging_apps_guidelines.md b/packaging_apps_guidelines.md index d0d3cab6..c017a1f3 100644 --- a/packaging_apps_guidelines.md +++ b/packaging_apps_guidelines.md @@ -213,7 +213,7 @@ There is also README.md, which must and can contain: #### YEP 1.12 ##### Follow the template from [example_ynh](https://github.com/YunoHost/example_ynh) | draft | manual | OFFICIAL | In order to facilitate the work of the community regarding a package, it has to follow the template shown by the example app. -This will help other packagers to read, modified and debug the package. Also, it will help to prolong the life of the package by giving it a standard template that other packagers will be able to quickly understand in case a package become orphan. +This will help other packagers to read, modify and debug the package. Also, it will help extend the life of the package by giving it a standard template that other packagers can quickly understand in the event that a package becomes orphaned. As well, a package should not use exotic or uselessly complicated code if it's not really needed. If so, this part of the code should be clearly documented. Keep your code as easy as possible, keep everything a script needs directly into it. Do not move functions in another file. Keep it simple and efficient.