jquery/sizzle

Reorganize docs

Open

#366 ouverte le 11 nov. 2015

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)JavaScript (991 forks)batch import
help wanted

Métriques du dépôt

Stars
 (6 264 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

Guide contributeur

Direction de recherche
Déplacez la documentation de l'API du wiki vers le README.md, en mettant l'accent sur l'utilisation. Ensuite, déplacez les directives restantes de développement et de contribution vers CONTRIBUTING.md et assurez vous que le README.md pointe vers CONTRIBUTING.md.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90