Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document best practices when adding images to documentation

Aperta
#153 1 commento 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
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
cli, documentation

Direzione di ricerca

Non vengono indicati file, test o punti di ingresso CLI; inizia individuando la sezione della documentazione relativa alle immagini e tutti gli strumenti esistenti per ridurre le dimensioni delle immagini. Il lavoro è completato quando la documentazione copre la scelta del formato, la riduzione delle dimensioni, l’uso di pre-commit e la denominazione, e documenta chiaramente il comportamento e l’utilizzo del comando CLI richiesto.

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

Descrizione

images

Some obvious steps would be:

  1. Document how to choose an appropriate image format (JPG, PNG).
  2. Add CLI command that automatically reduces size of images.
  3. Document how to apply it before adding images to git history.
  4. Document how to sensibly name images.
Lingua principale
TypeScript
Stelle
15
Fork
46
Merge medio
1g 21h
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 oasisprotocol/docs

Tutte le issue di oasisprotocol/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.