Skip to content

Commit

Permalink
Merge pull request #244 from thowell/improve_docs
Browse files Browse the repository at this point in the history
Update contributing docs
  • Loading branch information
erez-tom authored Jan 12, 2024
2 parents fd9c479 + 4572f3d commit e5a6d3e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ we can review your implementation.

This code adheres to the [Google style](https://google.github.io/styleguide/).

- Include the standard copyright and license at the top of each file.
- The VSCode extension 'Clang-Format' can be used to format the C/C++ code to Google style.
- The package [cpplint](https://github.com/cpplint/cpplint) should be used to check for additional C/C++ style issues. Note: includes should follow the ordering found throughout MuJoCo MPC for consistency.
- The package [Pyink](https://github.com/google/pyink) can be used to format Python code. Please use: `--pyink-indentation 2 --line-length 80`.

## New Tasks

When submitting a PR for a new task using models from [MuJoCo Menagerie](https://github.com/google-deepmind/mujoco_menagerie), do not include assets directly. Instead, modify the task [CMakeLists](mjpc/tasks/CMakeLists.txt) to copy these assets to the build binary.

## Unit Tests

Before submitting your PR, you can test your change locally by invoking ctest:
Expand Down

0 comments on commit e5a6d3e

Please sign in to comment.