Open-source prep: MIT relicense, templates, SPDX headers#59
Merged
Conversation
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.
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
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
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"..py.Templates (synced from robot-code)
LICENSE, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, CODEOWNERS, PR template, ISSUE_TEMPLATE/*, CI workflow.
Code cleanup
src/mj_environment/environment.pyto the top (no circular dep — they were on lines 70-75, below helper functions).ruff check --fix --unsafe-fixes(replaced 17== True/Falsewith direct truth checks in tests) +ruff format.[tool.ruff]config (120 line-length, F/E/W/I,F401ignore on__init__.py).Testing
uv run pytest tests/ -v— 129 passeduv run ruff check .— All checks passeduv run ruff format --check .— 18 files already formattedBreaking changes
Related
Part of personalrobotics/robot-code#3