Skip to content

Open-source prep: MIT relicense, templates, SPDX headers#59

Merged
siddhss5 merged 1 commit into
mainfrom
chore/open-source-prep
Apr 5, 2026
Merged

Open-source prep: MIT relicense, templates, SPDX headers#59
siddhss5 merged 1 commit into
mainfrom
chore/open-source-prep

Conversation

@siddhss5
Copy link
Copy Markdown
Contributor

@siddhss5 siddhss5 commented Apr 5, 2026

Summary

Prepares mj_environment for public release. Part of personalrobotics/robot-code#3.

Changes

Licensing & authorship

  • LICENSE: BSD-3 → MIT (Siddhartha Srinivasa, 2025).
  • pyproject.toml: license = "MIT" (SPDX), email updated, urls + ruff config added.
  • README.md: "BSD-3-Clause — Personal Robotics Laboratory, University of Washington" → "MIT — see LICENSE".
  • SPDX + copyright headers on every .py.

Templates (synced from robot-code)

LICENSE, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, CODEOWNERS, PR template, ISSUE_TEMPLATE/*, CI workflow.

Code cleanup

  • Moved mid-file imports in src/mj_environment/environment.py to the top (no circular dep — they were on lines 70-75, below helper functions).
  • Wrapped one 135-char line in error message.
  • ruff check --fix --unsafe-fixes (replaced 17 == True/False with direct truth checks in tests) + ruff format.
  • [tool.ruff] config (120 line-length, F/E/W/I, F401 ignore on __init__.py).

Testing

  • uv run pytest tests/ -v — 129 passed
  • uv run ruff check . — All checks passed
  • uv run ruff format --check . — 18 files already formatted

Breaking changes

  • None

Related

Part of personalrobotics/robot-code#3

Preparing mj_environment for public release (see personalrobotics/robot-code#3).

Licensing:
- LICENSE: BSD-3 → MIT, Copyright (c) 2025 Siddhartha Srinivasa.
- pyproject.toml: license = "MIT" (SPDX), authors email siddh@cs.washington.edu →
  siddhartha.srinivasa@gmail.com, urls added, ruff config added.
- README.md: "BSD-3-Clause — Personal Robotics Laboratory, University of
  Washington" → "MIT — see LICENSE".
- SPDX + copyright header on every .py (src/, tests/, demos/).

Templates synced from robot-code/.github-templates/.

Code cleanup:
- Moved mid-file imports in environment.py to the top (no circular dep).
- Wrapped one 135-char line.
- ruff check --fix + ruff format (incl. unsafe fixes: `== True/False` → direct).
- [tool.ruff] config: 120 line-length, F/E/W/I, __init__.py F401 ignore.

Verified: 129 tests pass, ruff check clean, ruff format clean.
@siddhss5 siddhss5 merged commit 9696472 into main Apr 5, 2026
1 of 4 checks passed
@siddhss5 siddhss5 deleted the chore/open-source-prep branch April 5, 2026 23:21
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.

1 participant