Add examples
Open
Nobody has claimed this yet.
good first issue
help wanted
- Dominant language
- Java
- Stars
- 71
- Forks
- 44
- Avg merge
- 12h 54m
- Merged PRs (30d)
- 7
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked SpdxModelFactory.java, LicenseInfoFactory.java, and SpdxComparer.java entry points to understand the three proposed workflows. Add runnable examples for creating a document and files, parsing license expressions, and comparing SPDX documents; done means all three common library usages are demonstrated clearly for first-time users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100