docs: add ADR template and contribution process - #92
Merged
Artifizer merged 3 commits intoAug 4, 2026
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe change updates contributor guidance, adds an ADR template, clarifies four ADR decisions, documents ChangesDocumentation and ADR decisions
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
code-ranker report for this PR (built on fork): https://reports.code-ranker.com/0FGX7CpmwJdMIFYuUtk0jA/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@adr/0003-x-gts-traits-completeness.md`:
- Line 230: Resolve the contradiction in the Option 3 section of the ADR by
aligning its completeness requirement with the `false` schema behavior: either
explicitly exempt types whose materialized effective traits object is empty, or
revise the `x-gts-traits-schema: false` edge-case wording to state that no
non-abstract descendant can be complete. Ensure the selected wording
consistently matches the completeness algorithm.
In `@adr/0004-x-gts-traits-merge-strategy.md`:
- Around line 483-489: Update the trait merge and validation semantics in §9.7.5
so RFC 7396 null-based deletion cannot bypass an optional const-locked trait:
either require locked properties in the effective trait-schema or reject
deletion during merge. Ensure the selected behavior preserves const enforcement,
and add a conformance test covering a descendant setting an optional
const-locked trait to null.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: b378a9fb-af05-415a-b218-fe9db5024981
📒 Files selected for processing (6)
CONTRIBUTING.mdadr/0001-derivation-form.mdadr/0002-x-gts-traits-schema.mdadr/0003-x-gts-traits-completeness.mdadr/0004-x-gts-traits-merge-strategy.mdadr/template.md
- Require ADRs for normative specification changes and document the validation workflow. - Add a project-adapted ADR template and align existing ADR headings with it. Signed-off-by: Aviator 5 <ai.agent.tor@gmail.com>
Signed-off-by: Aviator 5 <ai.agent.tor@gmail.com>
aviator5
force-pushed
the
adr-template-and-extend-contributing
branch
from
August 3, 2026 17:36
1f6357c to
5537fa2
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@adr/0004-x-gts-traits-merge-strategy.md`:
- Around line 437-441: Update adr/0004-x-gts-traits-merge-strategy.md lines
437-441 and README.md line 1625 to state that nested required traits are
protected only when every parent path segment is present, and that protection
requires requiring each parent, restoring the complete path with defaults, or
rejecting parent deletion. Extend tests/test_op13_schema_traits_validation.py
lines 3394-3441 with nested-parent deletion coverage, distinguishing parent
removal from literal null, and assert the specific required-property validation
failure.
In `@tests/test_op13_schema_traits_validation.py`:
- Around line 3394-3441: Extend TestCaseOp13_Merge_ConstLock_NullDeleteFails
with a nested parent object containing a required const property, then attempt
to delete that parent through merge and assert the resulting validation failure
specifically reflects the missing required property. Ensure the assertion
distinguishes RFC 7396 null-deletion semantics from incorrectly validating
literal null.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 9498ea54-d1a8-49ae-a28b-da0ffa473303
📒 Files selected for processing (8)
CONTRIBUTING.mdREADME.mdadr/0001-derivation-form.mdadr/0002-x-gts-traits-schema.mdadr/0003-x-gts-traits-completeness.mdadr/0004-x-gts-traits-merge-strategy.mdadr/template.mdtests/test_op13_schema_traits_validation.py
🚧 Files skipped from review as they are similar to previous changes (4)
- adr/0001-derivation-form.md
- adr/0003-x-gts-traits-completeness.md
- adr/0002-x-gts-traits-schema.md
- adr/template.md
- Explain why required and const constraints vanish when an optional parent is deleted. - Add OP#13 conformance cases for required and optional nested-lock paths. Signed-off-by: Aviator 5 <ai.agent.tor@gmail.com>
Artifizer
approved these changes
Aug 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
constvalues, required properties, defaults, and merge-based deletion.Tests