Skip to content

docs(encoding): remove provenance and optimization history - #164

Merged
loothero merged 2 commits into
mainfrom
chore/encoding-remove-provenance
Oct 3, 2026
Merged

loothero merged 2 commits into
mainfrom
chore/encoding-remove-provenance

Conversation

@loothero

@loothero loothero commented Oct 3, 2026

Copy link
Copy Markdown
Member

Remove packages/encoding/PROVENANCE.md, its README link, and the historical optimization comparisons. The README focuses on the API, current testing and coverage requirements, and reproducible benchmark commands, with a brief Beast NFT source attribution.

No build, test, or benchmark script depends on the deleted document. Production code, fixtures, and the complete test harness are unchanged.

Validation: workspace formatting and formatting checks passed; all 401 encoding tests passed with no ignored or filtered tests. Fixture hashes and generated test declarations verified; no dangling references to the deleted document remain.

@loothero
loothero requested a review from starknetdev as a code owner October 3, 2026 16:19
Copilot AI balanced review requested due to automatic review settings October 3, 2026 16:19

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 6 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 17e9d45d-17b7-4783-b08f-1db044c89ad6
📥 Commits

Reviewing files that changed from the base of the PR and between 8e7cf61 and 85296b2.

📒 Files selected for processing (2)
  • packages/encoding/PROVENANCE.md
  • packages/encoding/README.md
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-03T16:21:17.338659Z 918ea00 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown

claude-opus-5-5-medium Code Review: 918ea00

lgtm

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown

gpt-6.1-sol-high Code Review: 918ea00

lgtm

Removed outdated information about the encoder's origin.
@loothero
loothero merged commit 882ec52 into main Oct 3, 2026
3 checks passed
@loothero
loothero deleted the chore/encoding-remove-provenance branch October 3, 2026 16:21
@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown

claude-opus-5-5-medium Code Review: 85296b2

[MEDIUM] packages/encoding/README.md:112 - The PR body says the README keeps "a brief Beast NFT source attribution", but commit 85296b2 removed that sentence. This diff also deletes PROVENANCE.md, so no file in this diff credits the original source any more. The deleted file said "this transfer preserves that attribution and asserts no separate license grant". That attribution was a condition of bringing the code in, not historical commentary.
Impact: Once this merges, the encoding package README no longer credits the Beast NFT project as the encoder's origin, and the PR description no longer matches what ships. If the upstream code's license requires attribution, the package is out of compliance from this merge onward.
Fix: Restore the attribution at the end of the README (or in a short "Attribution" section):

The encoder was originally based on the Base64 encoder from the Beast NFT
project.

If dropping it was intentional, update the PR body and confirm the upstream license doesn't require attribution.

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown

gpt-6.1-sol-high Code Review: 85296b2

lgtm

@codecov

codecov Bot commented Oct 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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