Skip to content

docs: clarify EgoPost licensing in public documentation - #1314

Merged
qingsi-at-nv merged 1 commit into
mainfrom
qingsi/license-update
Oct 21, 2026
Merged

qingsi-at-nv merged 1 commit into
mainfrom
qingsi/license-update

Conversation

@qingsi-at-nv

@qingsi-at-nv qingsi-at-nv commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Description

Fixes #(issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Testing

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

Summary by CodeRabbit

  • Documentation
    • Updated license badges and links to distinguish the default Apache-2.0 license from EgoPost’s OpenMDW-1.1 license.
    • Clarified license exceptions and header-management guidance, including attribution requirements and review of automatic updates.

Signed-off-by: Qingsi Wang <qingsiw@nvidia.com>
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: a884e3a1-7f52-46f1-9c7a-f08d90f043f1
📥 Commits

Reviewing files that changed from the base of the PR and between 725b1a9 and 596b457.

📒 Files selected for processing: 3
  • README.md
  • docs/source/development/license.rst
  • docs/source/index.rst

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Walkthrough

The README and documentation now distinguish the default Apache-2.0 license from EgoPost’s OpenMDW-1.1 license. The license documentation also describes how pre-commit checks and updates headers, selects licenses by path, and preserves attribution and exceptions.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 596b4

The documentation updates are mergeable with no identified functional or operational risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the documentation changes that clarify EgoPost licensing.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@github-actions

Copy link
Copy Markdown
Contributor

✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1314/

Built from commit 596b457. It may take a minute for the updated preview to appear.

@qingsi-at-nv
qingsi-at-nv merged commit ed0c51e into main Oct 21, 2026
39 checks passed
@qingsi-at-nv
qingsi-at-nv deleted the qingsi/license-update branch October 21, 2026 21:55
github-actions Bot added a commit that referenced this pull request Oct 21, 2026

This branch was previously deployed

1 inactive deployment
dev — 596b457d Deployed Oct 21, 2026 by qingsi-at-nv via publish-wheel #5823
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants