Doc suggestion: clarify version and degree of YAML spec compliance
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.2k
- Forks
- 370
- PR merge metrics
- No merged PRs in 30d
Description
I think it would help if the README or some other piece of top-level documentation provided some guidance regarding what version or versions of the YAML spec this library aims to support, and how fully it supports that spec.
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 README and other top-level documentation to see where project support details are currently described. Document the YAML specification version or versions targeted by libyaml and explain the degree of compliance; the work is done when users can find that guidance in the top-level documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100