github-changelog-generator/github-changelog-generator

[DOC] Add a usage example using --future-release

Offen

#683 geöffnet am 27.09.2018

Auf GitHub ansehenContributor Guide
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Ruby (846 Forks)batch import
documentationhacktoberfesthelp wanted

Repository-Metriken

Stars
 (7.523 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The README needs a worked example of using the --future-release feature, so that CI tools and so on can build the CHANGELOG before any tags are created, keeping the CHANGELOG "inside the right tag".

  • Add a heading
  • Add an example
  • Add an introduction explaining when someone needs to use this

Update: You can extend the draft @mob-sakai created as a comment on this Issue.

https://github.com/github-changelog-generator/github-changelog-generator/issues/672#issuecomment-424941992

Contributor Guide

Research-Richtung
Überprüfe den Beispielentwurf im Issue Kommentar #424941992, füge eine Überschrift, ein Beispiel und eine Erklärung für die future release Funktion in der README hinzu.
Tech Stack
ruby
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85