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

Check readme examples

Aperta
  • Qualcosa non va?
#221 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 12 giorni

Una pull request collegata è già stata integrata.

  • #256 di @Pfeil — integrata

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia esaminando gli esempi del README rispetto all'API Java attuale, in particolare il metodo addContent obsoleto, e consulta la guida alla transizione nelle note di rilascio v2.0.0. Il lavoro è completato quando gli esempi sono aggiornati; determina inoltre se gli esempi esistenti sono coperti dai test e se il README debba mantenere un solo esempio rappresentativo.

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

Descrizione

documentation good first issue

The readme examples are partially outdated. For example, it still shows the addContent method.

  • This should be fixed and the examples should be checked
  • Consider some automated workflow for the examples. The Readme is a bit bloated with examples anyway. We should consider making tests out of them (if they aren't) and link to them instead. This will shorten the readme. We could keep one representational example in the readme so the user gets an immediate idea of how this will work.

Side note: I added a transition guide in the release notes of v2.0.0 regarding the renamed addContent function.

Lingua principale
Java
Stelle
5
Fork
4
Merge medio
12g 10h
PR unite (30g)
8

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Nessun Dockerfile né file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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 kit-data-manager/ro-crate-java

Tutte le issue di kit-data-manager/ro-crate-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.