github-changelog-generator/github-changelog-generator

[doc] Add Case Studies/Use-cases section, with examples from real-world usage

Open

#693 ouverte le 19 nov. 2018

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Ruby (846 forks)batch import
documentationhacktoberfesthelp wanted

Métriques du dépôt

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

Description

This Issue is a call for documentation additions about how people have used this tool.

Here's how one Node.js software project uses this tool to "improve release process":

https://github.com/davewasmer/ember-cli-favicon/commit/08be5a5a105bbeef359a5e252d2ace0a1334411e

Detail:

  • a gcg config file with a single option
  • a config file for ember-cli-release to call the tool

Guide contributeur

Direction de recherche
Ajoutez une section d'études de cas à la documentation en utilisant l'exemple fourni (commit ember cli favicon) et, éventuellement, trouvez d'autres exemples d'utilisation réelle dans l'historique des commits de l'outil ou dans la communauté.
Stack technique
ruby
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90