Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (33 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.64 KB
Raw

Contributing to LeIsaac

Thanks for your interest in contributing to LeIsaac! This document describes how to report issues, propose changes, and submit pull requests.

Code of conduct

Be respectful and constructive. Assume good intent.

Getting help / asking questions

Reporting bugs

When filing an issue, please include:

  • What you expected to happen vs what happened
  • Minimal steps to reproduce
  • Your environment (OS, GPU, driver, Python version, Isaac Sim / IsaacLab version)
  • Relevant logs and stack traces (as text)

Proposing changes

For non-trivial changes (new features, refactors, API changes), please open an issue first to align on scope and design.

Pull request guidelines

  • Keep PRs focused: one logical change per PR.
  • Write clear commit messages.
  • Update documentation when behavior or usage changes.
  • Describe a manual test plan in the PR.

Style and linting

LeIsaac uses pre-commit for formatting and lint checks (see .pre-commit-config.yaml at the repo root). GitHub Actions also runs these checks on every PR/update.

It is strongly recommended to run the checks locally before opening/updating a PR.

# Install pre-commit:
pip install pre-commit
# Install the git hooks (one time per clone):
pre-commit install
# Run all hooks on all files (recommended before opening/updating a PR):
pre-commit run --all-files

License

By contributing, you agree that your contributions will be licensed under the project's license (see LICENSE).