Add examples
Offen
Dieses Issue hat noch niemand übernommen.
good first issue
help wanted
- Vorherrschende Sprache
- Java
- Sterne
- 71
- Forks
- 44
- Ø Merge
- 12 Std. 54 Min.
- Gemergte PRs (30 T.)
- 7
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den verknüpften Einstiegspunkten SpdxModelFactory.java, LicenseInfoFactory.java und SpdxComparer.java, um die drei vorgeschlagenen Arbeitsabläufe zu verstehen. Füge ausführbare Beispiele zum Erstellen eines Dokuments und von Dateien, zum Parsen von Lizenz-Ausdrücken und zum Vergleichen von SPDX-Dokumenten hinzu; als abgeschlossen gilt die Aufgabe, wenn alle drei gängigen Bibliotheksverwendungen für Erstbenutzer klar demonstriert werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100