docsifyjs / docsifyjs/docsify

[Plugins] : Independent Test Solution for plugins

Ouverte
#1,021 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
help wanted pinned
Langage dominant
JavaScript
Étoiles
31.5k
Forks
5.8k
Merge moyen
9 j 8 h
PR mergées (30 j)
2

Description

This is more like a way or solution request for plugins to independently tests with docsify.
Currently, the official plugins and most of the third-party plugins (all of them which I saw) don't have test for their plugins. Unit testing for the logic method of a plugin can be done seamlessly but for integration testing with docsify core, it's quite tough from my end.

This is required as in future release there can be some changes in the core regarding the compiler part or the hooks part or any other changes. And it is to ensure that plugins don't break.

This issue is to document the testing guide for the plugins independently. As I am not so good with testing this deep I can't document that myself.

You can either submit a PR in this repo regarding updating the docs about testing the plugins.
Before submitting PR, it would be nice to have a comment here about your approach and also to have a demo by either testing any plugins from this repo or any other plugin.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

L’issue ne nomme aucun fichier de documentation, aucune commande de test ni aucun point d’entrée de plugin. Commencez par examiner comment le compilateur du cœur de docsify et les hooks interagissent avec un plugin existant, puis documentez un guide reproductible de test d’intégration indépendant et démontrez-le avec un plugin. La tâche est terminée lorsque le guide explique comment détecter les régressions d’un plugin après des modifications du cœur.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation, testing
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.