HowProgrammingWorks / HowProgrammingWorks/CodeStyle
Write the JavaScript styleguide
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 4
- Forks
- 2
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
For the moment our JavaScript styleguide exists implicitly and can only be inferred from reading our source code. The eslint config that we use in our projects covers the most essential parts of the code style, but a great deal of style-related things cannot be checked by linter, though the eslint config should definitely be placed in this repo too. We need to document our JavaScript code style and save these conventions both there and in Metarhia repositories.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner le code source JavaScript existant et la configuration eslint utilisée dans les projets afin d’identifier les conventions qui ne sont pas vérifiées par le linting. Documentez les conventions dans un styleguide, ajoutez la configuration eslint à ce dépôt et assurez-vous que les recommandations ainsi obtenues puissent être enregistrées dans les dépôts Metarhia.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- eslint, javascript
- Domaine
- documentation, tooling
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100