Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

docs: improve documentation of 'config' option

Ouverte
#262 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
40/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript
Domaine
documentation

Piste de recherche

Commencez par la documentation liée des options de commit-analyzer et examinez la description de l’option config par rapport aux questions de cette issue. Mettez à jour la documentation pour expliquer le nom du package, toute configuration requise et si les options enfants sont prises en charge ; le travail est terminé lorsque chaque question a une réponse sans ambiguïté.

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

Description

https://github.com/semantic-release/commit-analyzer#options

npm package name of a custom conventional-changelog preset.
i.e "conventional-changelog-conventionalcommits"?

  • Am I correct in understanding this 'name' would be the same value as used in the following example?
    npm install $name
  • Does the 'config' option require additional configuration like the 'preset' option may require the 'presetConfig' option depending on its value?
  • Does it expose options/parameters of the selected config as configurable child objects similar to how options are passed to a plugin?
Langage dominant
JavaScript
Étoiles
446
Forks
82
Merge moyen
7 h 53 min
PR mergées (30 j)
9

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de semantic-release/commit-analyzer

Toutes les issues de semantic-release/commit-analyzer

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

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