adds formating process

Author: louislelay

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+ # Ruff version.
+ rev: v0.12.3
+ hooks:
+ # Run the linter.
+ - id: ruff-check
+ args: [ --fix ]
+ # Run the formatter.
+ - id: ruff-format

Makefile

@@ -0,0 +1,8 @@
+.PHONY: sync
+sync:
+uv sync --all-extras --all-packages
+
+.PHONY: format
+format:
+uv run ruff format
+uv run ruff check --fix

README.md

@@ -52,6 +52,14 @@ Evaluate the policy.
 uv run bdx_r_play Mjlab-Velocity-Flat-BDX-R-Play --wandb-run-path your-org/mjlab/run-id
 ```
 
+## Contributing
+
+We look forward for contributions. Before submitting a PR, please run the following command for format:
+
+```bash
+make format
+```
+
 ## Acknowledgements
 
 We're grateful to the people behind MjLab, MuJoCo Warp and Isaac Lab.