JuliaIO / JuliaIO/JSONSchema.jl
Things to clean up in v2.0
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 40
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Formatting
I can't deal with code that isn't formatted anymore.
Tests
Get back to 100% code coverage (or as near to it as possible). There is currently a bunch of untested code.
Code style
There are many isa when we can use dispatch. Here's one example:
I don't know what the point of this part is
Surely it's just T <: Integer
Split schema validation and schema generation
There are really two separate things here. The current file is a bit confusing to me
The validation code
v2 has changed how we structure the validation code. I used to use dispatch to separate out each thing in the schema:
This made it easy to reason about what parts of the schema were covered and not. I think it's a shame to loose that.
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
Read src/schema.jl and src/validation.jl, starting with the linked isa checks and the existing validation structure. Inventory the formatting, coverage, dispatch, and schema-splitting concerns before proposing scope; done requires an agreed design plus corresponding changes and tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design, testing-qa
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100