This is a large refactor. The public API remains largely unchanged though a few bug fixes may cause some breaking changes.
The main improvement here was to code readability. This was in an effort to improve the development experience for contributors (and myself).
The largest refactor was in the router package. A new package called kit was introduced and it houses functionality which is shared and/or too general to be package-specific.
There's more to do but I am feeling confident that this is now ready for release.
Types of changes
What types of changes does your code introduce to Crayon?
Put an x in the boxes that apply
[x] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
[x] Lint and unit tests pass locally with my changes
[x] I have added tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation (if appropriate)
Proposed changes
This is a large refactor. The public API remains largely unchanged though a few bug fixes may cause some breaking changes.
The main improvement here was to code readability. This was in an effort to improve the development experience for contributors (and myself).
The largest refactor was in the
routerpackage. A new package calledkitwas introduced and it houses functionality which is shared and/or too general to be package-specific.There's more to do but I am feeling confident that this is now ready for release.
Types of changes
What types of changes does your code introduce to Crayon? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments