Add examples
Aperta
Nessuno ha ancora preso questa issue.
good first issue
help wanted
- Lingua principale
- Java
- Stelle
- 71
- Fork
- 44
- Merge medio
- 12h 54m
- PR unite (30g)
- 7
Descrizione
It would help first time users to create some examples for common library usage.
Some ideas for different examples:
- Creating a document, adding a few files using the SPDX Model Factory
- Parsing license expressions using the SPDX license parser
- Comparing SPDX documents using the SPDX Document Comparer
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con i punti di ingresso collegati SpdxModelFactory.java, LicenseInfoFactory.java e SpdxComparer.java per comprendere i tre flussi di lavoro proposti. Aggiungi esempi eseguibili per creare un documento e dei file, analizzare le espressioni di licenza e confrontare documenti SPDX; il lavoro sarà considerato completato quando tutti e tre gli utilizzi comuni della libreria saranno dimostrati chiaramente per gli utenti alle prime armi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100