JSR: Improve score with improved documentation, examples and package settings

Aperta
#3,597 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
deno, typescript

Direzione di ricerca

Start with the unchecked items under “JSR Maintainer Actions” and “Documentation efforts”; the completed entries link to issues #3600, #3598, #3603, and #3604 for examples of the work. Review the linked package pages and Fresh entry points for the remaining descriptions, module docs, and public types. Done when the outstanding checklist items are addressed or tracked separately; the issue leaves several choices open and has no recent discussion.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

docs feat

Given that Fresh is used by Deno and a very well used and visible package, it would be great if all packages under the @fresh scope on JSR had high scores.

Show current scores 👇 Image Image

I've created this issue as an umbrella issue to track various adjustments that should be quick to do to help improve scoring for all packages.

JSR Maintainer Actions

Requires admin/member of @fresh to update.

Has provenance ✅
Mark deno as compatible runtime
Add description to the package
  • @fresh/build-id
    • Suggestion: Internal Fresh dependency, do not use directly
  • @fresh/core
    • Suggestion: Fresh is a small, fast and extensible full stack web framework built on Web Standards. It’s designed for building high-quality, performant, and personalized web applications
    • (Text taken from from README.md)
  • @fresh/init
    • Suggestion: A CLI tool to bootstrap a new Fresh project
    • (Text taken from from README.md)
  • @fresh/plugin-tailwind
    • Suggestion: A plugin for Fresh to use Tailwind CSS
  • @fresh/plugin-tailwind-v3
    • Suggestion: A plugin for Fresh to use Tailwind CSS v3
  • @fresh/update
    • Suggestion: A CLI tool to help upgrade an existing Fresh project
    • (Text taken from from README.md)

Documentation efforts

No slow types ✅
Examples in README.md or module doc
Module docs for all entrypoints
Has docs for most symbols

As this task is much larger than the other steps, this is tracked separately.

  • #3596
Export non-exported public API types

A non-exhaustive list of types that probably should be made public, as they are used in public signatures already.

Types from other dependencies

There are some types in the JSR automated documentation that comes from other packages, e.g. @fresh/plugin-tailwind using a @fresh/core/dev type, or @fresh/core using preact types. What's best practice here? How to make types linked to the correct definition?

Lingua principale
TypeScript
Stelle
13.8k
Fork
757
Merge medio
3m
PR unite (30g)
2

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di freshframework/fresh

Tutte le issue di freshframework/fresh

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.