Skip to content

Readme cleanup#78

Merged
felipestanzani merged 8 commits intotoon-format:mainfrom
jenspapenhagen:readme
Dec 14, 2025
Merged

Readme cleanup#78
felipestanzani merged 8 commits intotoon-format:mainfrom
jenspapenhagen:readme

Conversation

@jenspapenhagen
Copy link
Collaborator

@jenspapenhagen jenspapenhagen commented Dec 11, 2025

Linked Issue

  • cleanup the README
  • adding Example for Jackson Annotation in the Readme
  • adding Test for Jackson Annotation
  • EncodeOptions naming schema like DecodeOptions

Closes #

Description

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test coverage improvement

Changes Made

  • EncodeOptions get changed

SPEC Compliance

  • This PR implements/fixes spec compliance
  • Spec section(s) affected:
  • Spec version:

Testing

  • All existing tests pass
  • Added new tests for changes
  • Tests cover edge cases and spec compliance

Pre-submission Checklist

  • My code follows the project's coding standards
  • I have run code formatting/linting tools
  • I have added tests that prove my fix/feature works
  • New and existing tests pass locally
  • I have updated documentation if needed
  • I have reviewed the TOON specification for relevant sections

Breaking Changes

  • No breaking changes
  • Breaking changes (describe migration path below)

Additional Context

@jenspapenhagen jenspapenhagen requested a review from a team as a code owner December 11, 2025 19:33
Copy link
Collaborator

@felipestanzani felipestanzani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that some tests to assert Jackson Annotations are needed before stating we fully support them all.

Copy link
Collaborator

@felipestanzani felipestanzani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good fixes to documentation.

Copy link
Collaborator

@felipestanzani felipestanzani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is important to keep notice of breaking changes on EncodeOptions before the release.

Copy link
Collaborator

@felipestanzani felipestanzani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The EncodeOptions flatten is a breaking change. Please fix the PR description because. It is important to keep track of this change before the next release.

@felipestanzani felipestanzani merged commit 04b00ad into toon-format:main Dec 14, 2025
1 check passed
@github-actions
Copy link
Contributor

Code Coverage

Overall Project 98.21% -0.02% 🍏
Files changed 99.07% 🍏

File Coverage
KeyFolding.java 100% 🍏
EncodeOptions.java 98.82% -1.18% 🍏
ObjectEncoder.java 96.28% 🍏

@jenspapenhagen jenspapenhagen deleted the readme branch December 14, 2025 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants