typelevel/cats-effect

Smarter version numbers in the docs

Open

#523 geöffnet am 1. Mai 2019

Auf GitHub ansehen
 (23 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Scala (572 Forks)batch import
:books: docsgood first issue

Repository-Metriken

Stars
 (2.230 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 21T 23h) (18 gemergte PRs in 30 T)

Beschreibung

When we release, we have to change the version number twice in the README and once in the tut. The README is currently included directly in the site. sbt-microsite has some automation for the latter, but can't help with the former.

  1. Consider making a more anemic README that drives straight to the site.
  2. Derive the version number in the site when publishing.

Failure to do so was responsible for #252.

Relevant Gitter conversation

Contributor Guide

Research-Richtung
Untersuche die Automatisierung von Versionsnummer Updates in der Dokumentation mit sbt microsite und erwäge die Reduzierung von README Duplikaten.
Tech Stack
scala
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
Scalasbt
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60