Skip to content

docs: add ATTRIBUTION.md for Recordly zoom animation code#273

Closed
ekkoitac wants to merge 1 commit intosiddharthvaddem:mainfrom
ekkoitac:fix/add-attribution-v2
Closed

docs: add ATTRIBUTION.md for Recordly zoom animation code#273
ekkoitac wants to merge 1 commit intosiddharthvaddem:mainfrom
ekkoitac:fix/add-attribution-v2

Conversation

@ekkoitac
Copy link
Copy Markdown

@ekkoitac ekkoitac commented Apr 2, 2026

Summary

Add attribution crediting Recordly for the zoom & pan animation system ported into OpenScreen, as requested in #263.

Changes

  • New file ATTRIBUTION.md — lists Recordly as the source of the zoom/pan animation code (mathUtils.ts and zoomRegionUtils.ts)
  • Updated README.md — added Attribution section linking to ATTRIBUTION.md
  • Inline headers in mathUtils.ts and zoomRegionUtils.ts — added // Ported from Recordly comment headers per review
  • clamp01() added to the attribution entry per review

Fixes: #263

Summary by CodeRabbit

  • Documentation
    • Added a new attribution file documenting open-source attributions and providing detailed acknowledgments
    • Updated README.md with a dedicated Attribution section directing users to attribution details
    • Added attribution header comments to animation-related utility modules with references to attribution documentation

- Update ATTRIBUTION.md to list clamp01() alongside easeOutScreenStudio()
  and cubicBezier()
- Add inline attribution header comment to mathUtils.ts
- Add inline attribution header comment to zoomRegionUtils.ts
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5a086506-0450-4c23-af96-97b96a8924fb

📥 Commits

Reviewing files that changed from the base of the PR and between e35780b and 29f3fe3.

📒 Files selected for processing (4)
  • ATTRIBUTION.md
  • README.md
  • src/components/video-editor/videoPlayback/mathUtils.ts
  • src/components/video-editor/videoPlayback/zoomRegionUtils.ts

📝 Walkthrough

Walkthrough

This pull request adds attribution documentation for zoom and pan animation code ported from Recordly. A new ATTRIBUTION.md file documents the attribution with specific function references, while comments are added to related source files and README.md is updated to reference the attribution file.

Changes

Cohort / File(s) Summary
Attribution Documentation
ATTRIBUTION.md, README.md
Created new ATTRIBUTION.md file with detailed attribution to Recordly for zoom & pan animation system and ported functions; updated README.md to reference the new attribution file.
Source Code Attribution Comments
src/components/video-editor/videoPlayback/mathUtils.ts, src/components/video-editor/videoPlayback/zoomRegionUtils.ts
Added file-level attribution comments indicating code was ported from Recordly and directing to ATTRIBUTION.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A whisker-twitch of gratitude so fine,
To Recordly's magic, now properly aligned,
Attribution's dance, a hop and a spring,
Makes OpenScreen's zoom just the sweetest thing!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding attribution documentation for Recordly's zoom animation code.
Description check ✅ Passed The description covers the purpose, changes made, and linked issue, though it omits some template sections like Type of Change and Testing details.
Linked Issues check ✅ Passed All code changes directly fulfill issue #263's requirement to attribute Recordly for the zoom & pan animation code through ATTRIBUTION.md and inline comments.
Out of Scope Changes check ✅ Passed All changes are within scope: ATTRIBUTION.md creation, README.md attribution section, and inline attribution headers in relevant source files directly address issue #263.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@siddharthvaddem
Copy link
Copy Markdown
Owner

This is a little over the top when you could do something like this
https://github.com/siddharthvaddem/openscreen/pull/260/changes

We apologize for the omission and thank Recordly's maintainers for their excellent work.

this is not funny and overly bombastic. will be closing it. reopen with something like #260.

original author already credited them with their PR: #207 you can check the description edit history. I cannot control what people choose to edit and incorporate.

The creator of recordly is very well aware of every small detail happening in this repo since hes actively lurking and leaving comments/ prs and closing them. he replied on the very PR that introduced this change (half of which was heavily scrutinized and dismissed from being added upstream).

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.

Add attribution for zoom & pan animation code ported over from Recordly

2 participants