autowarefoundation · kenji-miyake · Jun 9, 2022 · May 14, 2022 · May 25, 2022 · Jun 9, 2022
diff --git a/docs/contributing/coding-guidelines/.pages b/docs/contributing/coding-guidelines/.pages
@@ -1,4 +1,4 @@
 nav:
   - index.md
-  - Language-specific coding guidelines: languages
-  - ROS nodes coding guidelines: ros-nodes
+  - Language-specific guidelines: languages
+  - ROS nodes guidelines: ros-nodes
diff --git a/docs/contributing/coding-guidelines/index.md b/docs/contributing/coding-guidelines/index.md
@@ -5,3 +5,12 @@
     Under Construction
 
 ## Common guidelines
+
+Refer to the following links for now:
+
+- <https://docs.ros.org/en/foxy/Contributing/Developer-Guide.html>
+
+Also, keep in mind the following concepts.
+
+- Keep things consistent.
+- Don't stick to the parts that can't be automated.
diff --git a/docs/contributing/coding-guidelines/languages/.pages b/docs/contributing/coding-guidelines/languages/.pages
@@ -1,11 +1,9 @@
 nav:
-  - index.md
   - cpp.md
   - python.md
   - shell-scripts.md
   - markdown.md
   - cmake.md
   - package-xml.md
-  - ros2-interfaces.md
   - docker.md
   - github-actions.md
diff --git a/docs/contributing/coding-guidelines/languages/cmake.md b/docs/contributing/coding-guidelines/languages/cmake.md
@@ -3,3 +3,12 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://docs.ros.org/en/foxy/Contributing/Code-Style-Language-Versions.html#cmake>
+
+## Use the autoware_package macro
+
+To reduce duplications in CMakeLists.txt, there is the `autoware_package()` macro.
+See the [README](https://github.com/autowarefoundation/autoware_common/tree/main/autoware_cmake) and use it in your package.
diff --git a/docs/contributing/coding-guidelines/languages/cpp.md b/docs/contributing/coding-guidelines/languages/cpp.md
@@ -3,3 +3,9 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://docs.ros.org/en/foxy/Contributing/Code-Style-Language-Versions.html#id1>
+- <https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines>
+- <https://www.autosar.org/fileadmin/user_upload/standards/adaptive/21-11/AUTOSAR_RS_CPP14Guidelines.pdf>
diff --git a/docs/contributing/coding-guidelines/languages/docker.md b/docs/contributing/coding-guidelines/languages/docker.md
@@ -3,3 +3,7 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://github.com/hadolint/hadolint>
diff --git a/docs/contributing/coding-guidelines/languages/github-actions.md b/docs/contributing/coding-guidelines/languages/github-actions.md
@@ -3,3 +3,7 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://docs.github.com/en/actions/guides>
diff --git a/docs/contributing/coding-guidelines/languages/index.md b/docs/contributing/coding-guidelines/languages/index.md
diff --git a/docs/contributing/coding-guidelines/languages/markdown.md b/docs/contributing/coding-guidelines/languages/markdown.md
@@ -3,3 +3,8 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://docs.ros.org/en/foxy/Contributing/Code-Style-Language-Versions.html#markdown-restructured-text-docblocks>
+- <https://github.com/DavidAnson/markdownlint>
diff --git a/docs/contributing/coding-guidelines/languages/package-xml.md b/docs/contributing/coding-guidelines/languages/package-xml.md
@@ -3,3 +3,8 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://ros.org/reps/rep-0149.html>
+- <https://github.com/tier4/pre-commit-hooks-ros#prettier-package-xml>
diff --git a/docs/contributing/coding-guidelines/languages/python.md b/docs/contributing/coding-guidelines/languages/python.md
@@ -3,3 +3,9 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://docs.ros.org/en/foxy/Contributing/Code-Style-Language-Versions.html#python>
+- <https://github.com/psf/black>
+- <https://github.com/PyCQA/isort>
diff --git a/docs/contributing/coding-guidelines/languages/ros2-interfaces.md b/docs/contributing/coding-guidelines/languages/ros2-interfaces.md
diff --git a/docs/contributing/coding-guidelines/languages/shell-scripts.md b/docs/contributing/coding-guidelines/languages/shell-scripts.md
@@ -3,3 +3,9 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://google.github.io/styleguide/shellguide.html>
+- <https://github.com/koalaman/shellcheck>
+- <https://github.com/mvdan/sh>
diff --git a/docs/contributing/coding-guidelines/ros-nodes/.pages b/docs/contributing/coding-guidelines/ros-nodes/.pages
@@ -1,5 +1,4 @@
 nav:
-  - index.md
   - class-design.md
   - console-logging.md
   - coordinate-system.md

diff --git a/docs/contributing/coding-guidelines/ros-nodes/index.md b/docs/contributing/coding-guidelines/ros-nodes/index.md
diff --git a/docs/contributing/discussion-guidelines/index.md b/docs/contributing/discussion-guidelines/index.md
@@ -3,3 +3,8 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://docs.github.com/en/discussions/guides/best-practices-for-community-conversations-on-github>
+- <https://opensource.guide/how-to-contribute/#communicating-effectively>
diff --git a/docs/contributing/documentation-guidelines/index.md b/docs/contributing/documentation-guidelines/index.md
@@ -3,3 +3,7 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://developers.google.com/style>
diff --git a/docs/contributing/pull-request-guidelines/review-guidelines.md b/docs/contributing/pull-request-guidelines/review-guidelines.md
@@ -3,3 +3,10 @@
 !!! warning
 
     Under Construction
+
+Refer to the following links for now:
+
+- <https://google.github.io/eng-practices/review/>
+- <https://docs.gitlab.com/ee/development/code_review.html>
+- <https://www.swarmia.com/blog/a-complete-guide-to-code-reviews/>
+- <https://rewind.com/blog/best-practices-for-reviewing-pull-requests-in-github/>