Fonctionalités méli-mélo

Fonctionalités réutilisables étant dans un stade préliminaire d'expérimentation. Les fonctionnalités sont composées de code personnalisé CSS et/ou Javascript. Dès qu'une fonctionnalité est développée et que les exigences minimales sont rencontrées, un méli-mélo peut être déployé et prêt à être utilisé à l'intérieur d'une semaine sur Canada.ca. Voir les mélis-mélos existants.

Saviez-vous que ? Du support est offert durant les Heures de service de la BOEW qui ont lieu à distance tous les mardis après-midis.

Compilations

La durée de vie approximative de chaque compilation est d'environ un (1) an, après quoi il devient "gelé" (obsolette). Cela devrait donner assez de temps au département parrain de trouver les ressources nécessaires afin de faire progresser leur fonctionnalité expérimentale vers une fonctionnalité officelle de GCWeb. Utiliser une compilation méli-mélo gelée sur une page web est fortement déconseillé. Ce doit être remplacé soit par la fonctionnalité GCWeb correspondante, par une autre compilation méli-mélo ou bien simplement être retiré.

Les fonctionalités sont regroupées sous forme de compilations afin de rapidement :

amorcer des recherches de convivialité;
amorcer les discussions préliminaires avec les organismes organismes clef;
transformer les fonctionnalités en produits de qualité adaptées pour GCWeb; et
regrouper et facilité une coordination centralisé pour les innovateurs(rices).

Compilations méli-mélo actives et leurs fonctionnalités

(Consulter les compilations méli-mélo gelées et obselettes.)

Créer une fonctionnalité méli-mélo

Vous avez une fonctionnalité prête à être soumisie en tant que méli-mélo? Voici ce que vous devez savoir.

Les exigences minimales pour une nouvelle fonctionnalité sont :

Doit être réutilisable;
Ne doit pas présenter d'interférence avec WET-BOEW & GCWeb, c'est-à-dire aucun chevauchement ou collision. Lorsque possible, l'extension d'une composante devrait être contribuée directement à travers la composante provisionnelle ou stable;
Doit être développé avec l'accessibilité et la sécurité en tête. La conformance à l'accessibilité demeure la responsabilité d'un éditeur lorsqu'il ou elle implémente la fonctionnalité sur une page web;
Ne doit pas affecter de contenu par défaut lors du chargement de la page en utilisant la technique de "closure" sauf si elle est explicitement activée à travers le HTML, soit à travers l'utilisation d'une classe CSS ou d'un attribut "data", tout comme le plugiciel WET-BOEW d'exemple;
Doit avoir un nom dans le bon format (voir exemple de nom de fonctionnalité ci-dessous).
Doit être parrainé par un département, avec un représentant actif de celui-ci;
Doit inclure un plan d'implémentation;
Doit avoir un démo / exemple pratique publié pour chaque sous-fonctionnalité et style individuellement, soit chaque configuration JS et chaque classe CSS respectivement;

Débuter

Vous trouverez ci-dessous les instructions sur comment créer une nouvelle fonctionnalité méli-mélo dans GCWeb.

Astuce pour débuter rapidement !

Commencez par coder et/ou exposer votre fonctionnalité et son ou ses démo(s) grâce au thème GCWeb Jekyll avant votre contribution à GCWeb.

Assurez-vous que le code de votre fonctionnalité est compris dans un seul fichier JavaScript et/our un fichier CSS.
Créez un nouveau dossier de fonctionnalité à l'intérieur du dossier /méli-mélo à la racine de GCWeb.
Nommez votre fonctionnalité et son dossier en suivant la nomenclature suivante : AAAA-MM-[NomFonctionnalité]. L'année et le mois doivent correspondent à la date de publication initiale de la fonctionnalité. Par exemple "2021-05-steps".
Créez et publiez vos démos / exemples pratiques pour chaque sous-fonctionnalité et style individuellement, soit chaque configuration JS et chaque classe CSS respectivement, soit en utilisant le thème GCWeb Jekyll ou bien GCWeb directement.
Désignez un parrain pour la fonctionnalité.
Écrivez et publiez le plan d'implémentation.
Assurez-vous que toutes les exigences minimales affiché plus haut sont rencontrées.
Optionnel : Testez votre code en suivant les instructions sur comment développer pour GCWeb.
Soumettez votre nouvelle fonctionnalité à travers une demandes de tirage (Pull Requests) (PR) dans le répertoire GCWeb; veuillez svp consulter les lignes directrices de contribution.
Si des changements sont jugées nécessaires après la revue technique de la PR (selon la liste de vérification ci-dessous), collaborez avec l'équipe de la WET-BOEW pour la faire approuver. À titre de référence, une première contribution méli-mélo prend habituellement 3+ rondes de revue de code prenant chacune une semaine.
Une fois votre PR approuvée, votre fonctionnalité sera assignée à une compilation méli-mélo et déployée sur Canada.ca lors de la prochaine fenêtre de déploiement une (1) semaine après que le code soit fusionné.
Fortement recommandé : Après le déploiement, mettez à jour le code de la fonctionnalité méli-mélo en exécutant le plan d'implémentation et en adressant tous les items à faire identifiés par l'équipe de la WET-BOEW.
Recommandé : Aussi souvent que possible, participez aux Heures de service de la BOEW les mardis après-midis. L'équipe de la WET-BOEW sera en mesure de vous aider à progresser et exécuter votre plan d'implémentation en trouvant des façons d'enlever les barrières techniques ou procédurales que vous rencontrez.

Voyez un exemple complet d'une fonctionnalité méli-mélo contenant toute l'information demandée en consultant 2021-05-steps et son dossier sur GitHub .

Liste de vérification pour revue technique

Cette liste contient les étapes que l'équipe de la WET-BOEW suivent pour approuver les nouvelles fonctionnalités mélis-mélos.

S'assure que le parrain est clairement identifié;
Vérifie que le nom du dossier du projet suit la bonne nomenclature : AAAA-MM-[NomFonctionnalité];
S'assure que chaque sous-fonctionnalité JavaScript et style CSS présente un démo / exemple pratique;
Performe une revue du code afin d'assurer qu'il n'y a pas de chevauchement ou de collision avec GCWeb and/or WET-BOEW;
Effectue une vérification rapide pour trouver des problèmes majeurs ou évident d'accessibilité ou de sécurité;
S'assure que la fonctionnalité n'affecte pas de contenu par défaut lors du chargement de la page en utilisant la technique de "closure" sauf si elle est explicitement activée à travers le HTML, soit à travers l'utilisation d'une classe CSS ou d'un attribut "data";
Révise le plan d'implémentation afin d'assurer qu'il contient des livrables et dates butoirs raisonables.

Parrainage

Le parrain est une entité responsable d'assurer qu'une fonctionnalité méli-mélo progresse vers une fonctionnalité stable & largement réutilisable tel que prescrit par le plan d'implémentation. Les chances sont grandes que le parrain d'une fonctionnalité soit l'auteur de celle-ci, puis que cette entité représente son département.

Plan d'implémentation

Le plan d'implémentation permet de mettre en place des étapes importantes afin d'arriver à stabiliser une fonctionnalité méli-mélo dans le code de WET-BOEW / GCWeb. Le plan doit contenir les étapes suivantes :

Collaboration avec le Bureau de la transformation numérique (BTN) au Secrétariat du Conseil du Trésor du Canada;
Réviser et performer l'identification du changement nécessaire afin de compléter l'intégration à GCWeb;
Produire un rapport de conformance à l'accessibilité et attacher un rapport de convivialité (le cas échéant);
Transformation de la fonctionnalité méli-mélo en tant que fonctionnalité provisionel dans GCWeb;
Compléter la tâche de stabilisation, qui inclue entre autres la traduction des l'exemple pratique, écrire les directives, publier le rapport de conformance à l'accessibilité, la documentation de l'API, etc.

Chaque élément du plan doit avoir une date butoir estimée en tant qu'indicateur pour mesurer le progrès de l'intégration à GCWeb. Ce qui est attendu est d'avoir la fonctionnalité méli-mélo intégrée à GCWeb à l'intérieur de sa durée de vie d'environ un (1) an. Voyez un exemple de plan d'implémentation.

Version

Ce système de compilations et fonctionnalités méli-mélo est exlcus de l'API publique de GCWeb (en anglais seulement). Tout changement ou retrait déclancherait seulement un déploiement de type "correctif" sur GCWeb. Cela signifie que le développeur est complètement responsable, mais n'est pas dans l'obligation, de documenter tout changement subséquent qu'il/elle apporterait à sa fonctionnalité méli-mélo.

Voir aussi :

thématiques promotionnelles du GC pour du code personnalisé qui est explicitement dédié au contenu promotionnel et qui affecte un nombre respectable de pages.

Détails de la page

Date de modification :

Sélection de la langue

Recherche