From e614a46a706cedb31239483ad39c74b5c9b2aff8 Mon Sep 17 00:00:00 2001 From: taylor howell Date: Thu, 11 Jan 2024 17:19:58 -0700 Subject: [PATCH 1/2] update contributing docs --- docs/CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1ec770b8e..f821f9495 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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 throught 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: From 05d292f5745ee9afbebf82d35a52e7f2847080dc Mon Sep 17 00:00:00 2001 From: taylor howell Date: Thu, 11 Jan 2024 17:21:08 -0700 Subject: [PATCH 2/2] fix typo --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f821f9495..c2e01a1b1 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -27,7 +27,7 @@ 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 throught MuJoCo MPC for consistency. +- 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