OAI / OAI/Arazzo-Specification
Inconsistent definition of field name constrains
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 471
- Forks
- 69
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 19
Description
Specification sometimes defines constrains for field names like ^[a-zA-Z0-9\.\-_]+$, other times like [A-Za-z0-9_\-]+. We should unify the format, unless there is a reason for inconsistency which I'm currently missing.
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
Search the specification for the field-name constraints using the two regex forms shown in the issue and compare their intended scopes. Unify the definitions where they describe the same constraint, or document the reason for keeping them different; done means the specification no longer has an unexplained inconsistency.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100