tsdjs/tsd

Improve documentation

Open

#55 geöffnet am 13. Nov. 2019

Auf GitHub ansehen
 (12 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (2.551 Stars) (68 Forks)user submission
help wantedquestion

Beschreibung

I think we need to improve the documentation a bit. But I'm not sure how to provide the right amount of information.

So any ideas here are more than welcome. Like, should we add more examples? Should we add an example per assertion to make it more clear? Is the description good enough?

Contributor Guide

Tech Stack
typescriptnodejs
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
unclear
Voraussetzungen
Basic TypeScript knowledgeUnderstanding of tsd assertions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
The issue is open ended, seeking ideas for improving documentation. Review the 12 comments for suggestions. Look at the current README and docs folder (likely in the repository root). Consider adding examples for each assertion type as mentioned in the issue body. Engage with maintainers to clarify scope and expectations.