YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #935 from YunoHost/YEP_1_12

Browse source 
Add YEP 1.12 - Follow example_ynh
This commit is contained in:
Maniack Crudelis 2019-03-12 19:11:44 +01:00 • committed by GitHub
commit 84b104c6cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
packaging_apps_guidelines.md
View file

@ -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, 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.
### YEP 2
#### Stabilize an app
#### YEP 2.1

8
packaging_apps_guidelines_fr.md
View file

@ -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