Generate serialized name (a name with profile prefix) in the document
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
When writing objects, pay attention to which profile the property is defined in, as that sets the prefix (the documentation should make it clear what the serialized name of a property is if you are unsure TODO: It does not yet).
From a TODO in Getting started writing SPDX 3 document.
Contributor guide
No contributing guide indexed for this repository
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 TODO in docs/annexes/getting-started.md and review the surrounding guidance on writing SPDX 3 objects. Clarify how a property's defining profile determines its serialized name and prefix; the TODO is done when the document explains this clearly for readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100