|
| 1 | +## Description |
| 2 | + |
| 3 | +<!-- Provide a clear and concise description of your changes --> |
| 4 | + |
| 5 | +## Type of Change |
| 6 | + |
| 7 | +<!-- Mark the relevant option with an [x] --> |
| 8 | + |
| 9 | +- [ ] Bug fix (non-breaking change that fixes an issue) |
| 10 | +- [ ] New feature (non-breaking change that adds functionality) |
| 11 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 12 | +- [ ] Documentation update |
| 13 | +- [ ] Refactoring (no functional changes) |
| 14 | +- [ ] Performance improvement |
| 15 | +- [ ] Test coverage improvement |
| 16 | + |
| 17 | +## Related Issues |
| 18 | + |
| 19 | +<!-- Link any related issues using #issue_number --> |
| 20 | + |
| 21 | +Closes # |
| 22 | + |
| 23 | +## Changes Made |
| 24 | + |
| 25 | +<!-- List the main changes in this PR --> |
| 26 | + |
| 27 | +- |
| 28 | +- |
| 29 | +- |
| 30 | + |
| 31 | +## SPEC Compliance |
| 32 | + |
| 33 | +<!-- If this PR relates to the TOON spec, indicate which sections are affected --> |
| 34 | + |
| 35 | +- [ ] This PR implements/fixes spec compliance |
| 36 | +- [ ] Spec section(s) affected: |
| 37 | +- [ ] Spec version: |
| 38 | + |
| 39 | +## Testing |
| 40 | + |
| 41 | +<!-- Describe the tests you added or ran --> |
| 42 | + |
| 43 | +- [ ] All existing tests pass |
| 44 | +- [ ] Added new tests for changes |
| 45 | +- [ ] Tested on Java 17 |
| 46 | +- [ ] Tested on Java 21 |
| 47 | + |
| 48 | +### Test Output |
| 49 | + |
| 50 | +```bash |
| 51 | +# Paste test output here |
| 52 | +``` |
| 53 | + |
| 54 | +## Code Quality |
| 55 | + |
| 56 | +<!-- Confirm code quality checks --> |
| 57 | + |
| 58 | +- [ ] Ran `./gradlew test` - all tests pass |
| 59 | +- [ ] Ran `./gradlew jacocoTestCoverageVerification` - coverage meets 85% threshold |
| 60 | +- [ ] Added JavaDoc comments for public APIs |
| 61 | +- [ ] Code follows Java conventions |
| 62 | + |
| 63 | +## Checklist |
| 64 | + |
| 65 | +<!-- Mark completed items with an [x] --> |
| 66 | + |
| 67 | +- [ ] My code follows the project's coding standards |
| 68 | +- [ ] I have added JavaDoc comments to new public APIs |
| 69 | +- [ ] I have added JUnit tests that prove my fix/feature works |
| 70 | +- [ ] New and existing tests pass locally |
| 71 | +- [ ] I have updated documentation (README.md if needed) |
| 72 | +- [ ] My changes do not introduce new dependencies (or are justified) |
| 73 | +- [ ] I have maintained Java 17+ compatibility |
| 74 | +- [ ] I have reviewed the [TOON specification](https://github.com/toon-format/spec) for relevant sections |
| 75 | + |
| 76 | +## Performance Impact |
| 77 | + |
| 78 | +<!-- If applicable, describe any performance implications --> |
| 79 | + |
| 80 | +- [ ] No performance impact |
| 81 | +- [ ] Performance improvement (describe below) |
| 82 | +- [ ] Potential performance regression (describe and justify below) |
| 83 | + |
| 84 | +<!-- Details: --> |
| 85 | + |
| 86 | +## Breaking Changes |
| 87 | + |
| 88 | +<!-- If this is a breaking change, describe the migration path for users --> |
| 89 | + |
| 90 | +- [ ] No breaking changes |
| 91 | +- [ ] Breaking changes (describe migration path below) |
| 92 | + |
| 93 | +<!-- Migration path: --> |
| 94 | + |
| 95 | +## Screenshots / Examples |
| 96 | + |
| 97 | +<!-- If applicable, add screenshots or example output --> |
| 98 | + |
| 99 | +```java |
| 100 | +// Example usage |
| 101 | +``` |
| 102 | + |
| 103 | +Output: |
| 104 | +``` |
| 105 | +# Example output |
| 106 | +``` |
| 107 | + |
| 108 | +## Additional Context |
| 109 | + |
| 110 | +<!-- Add any other context about the PR here (optional) --> |
| 111 | + |
| 112 | +## Checklist for Reviewers |
| 113 | + |
| 114 | +<!-- For maintainers reviewing this PR --> |
| 115 | + |
| 116 | +- [ ] Code changes are clear and well-documented |
| 117 | +- [ ] Tests adequately cover the changes |
| 118 | +- [ ] Documentation is updated |
| 119 | +- [ ] No security concerns |
| 120 | +- [ ] Follows TOON specification |
| 121 | +- [ ] Backward compatible (or breaking changes are justified and documented) |
0 commit comments