Added base pre-commit hooks to include whitespace and eol checks.

Signed-off-by: Leander Stephen D'Souza <leanderdsouza1234@gmail.com>

Author: leander-dsouza

.circleci/config.yml

@@ -68,7 +68,7 @@ jobs:
       - persist_to_workspace:
           root: .
           paths:
-            - _build 
+            - _build
   docs_publish:
     executor: docs_exec
     steps:

.gitignore

@@ -2,4 +2,4 @@ _build
 lib/
 bin/
 pyvenv.cfg
-.DS_Store
+.DS_Store

.pre-commit-config.yaml

@@ -21,3 +21,10 @@ repos:
       - id: codespell
         args: ['--write-changes', '--ignore-words=.codespell_words']
         exclude: CHANGELOG\.rst|\.(svg|pyc|drawio|dcf|eds)$
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace

2021summerOfCode/projects/assisted_teleop.rst

@@ -4,9 +4,9 @@
 3. Assisted Teleop
 ==================
 
-**Task description** 
+**Task description**
 
-In mobile robot and autonomous vehicle navigation, there are situations where a human driver is required to intervene to get the vehicle out of a sticky situation. This can be both as a backup in case of autonomy failure as well as the primary function of the robot (e.g. telepresence robots). 
+In mobile robot and autonomous vehicle navigation, there are situations where a human driver is required to intervene to get the vehicle out of a sticky situation. This can be both as a backup in case of autonomy failure as well as the primary function of the robot (e.g. telepresence robots).
 
 This project's aim is to create an assisted teleop feature in Nav2 by means of a new behavior tree configuration file (the file that defines the flow of information for the navigation task) and potentially new plugins. This feature should make sure to use the local costmap and/or sensor data in order to avoid obstacles and take position and/or velocity commands to attempt to follow.
 
@@ -31,7 +31,7 @@ This will be an excellent chance to make a substantial new feature in the Nav2 s
 - Mobile robot navigation experience
 - Recommended: Gazebo simulation, ROS navigation, Behavior trees
 
-**List of relevant open source software repositories and refs** 
+**List of relevant open source software repositories and refs**
 
 - `ROS <https://www.ros.org/>`_
 - `Gazebo Simulator <http://gazebosim.org/>`_

2021summerOfCode/projects/create_configuration_assistant.rst

@@ -5,7 +5,7 @@
 1. Create a Configuration Assistant (Analog to MoveIt)
 ======================================================
 
-**Task description** 
+**Task description**
 
 `Moveit <https://moveit.ros.org/>`_ has long has a QT `configuration assistant <http://docs.ros.org/kinetic/api/moveit_tutorials/html/doc/setup_assistant/setup_assistant_tutorial.html>`_. This setup assistant helps the user configure their UDRF and needs to setup MoveIt configuration files.
 
@@ -43,12 +43,12 @@ After the items are configured, there should be a preview to see how the paramet
 - 3D programming (maybe needed in the preview)
 - Recommended: Gazebo simulation, ROS, and Navigation experience
 
-**List of relevant open source software repositories and refs** 
+**List of relevant open source software repositories and refs**
 
 - `QT <https://www.qt.io/>`_
 - `Gazebo Simulator <http://gazebosim.org/>`_
 - `Original github issue page <https://github.com/ros-navigation/navigation2/issues/1721>`_
 
 **Licensing**
 - All contributions will be under the Apache 2.0 license.
-- No other CLA's are required.
+- No other CLA's are required.

2021summerOfCode/projects/create_plugins.rst

@@ -46,4 +46,3 @@ Your task will be to create a high-quality implementation of one of the followin
 **Licensing**
 - All contributions will be under the Apache 2.0 license.
 - No other CLA's are required.
-

2021summerOfCode/projects/dynamic.rst

@@ -5,7 +5,7 @@
 1. Navigation Dynamic Obstacle Integration
 ==========================================
 
-**Task description** 
+**Task description**
 
 The Navigation Stack has long provided robust navigation in a wide range of environments. Controllers have been developed to operate effectively in the presence of dynamic obstacles without explicitly modeling the characteristics of dynamic obstacles. However, as the field has progressed and we see more and more robots using ROS deployed in human-filled spaces, more consideration must be taken with respect to dynamic obstacles such as people, carts, animals, and vehicles.
 
@@ -33,7 +33,7 @@ If time permits, you may also work to also integrate this dynamic information in
 - Geometry and statistics
 - Recommended: Gazebo simulation, machine learning, ROS navigation
 
-**List of relevant open source software repositories and refs** 
+**List of relevant open source software repositories and refs**
 
 - `Starting project <https://github.com/ros-navigation/navigation2_dynamic/>`_
 - `ROS <https://www.ros.org/>`_

2021summerOfCode/projects/grid_maps.rst

@@ -8,7 +8,7 @@
 3. Port Grid Maps to ROS 2 and Environmental Model
 ==================================================
 
-**Task description** 
+**Task description**
 Grid Maps was created by ETH Zurich and later transferred to ANYbotics. It is a universal grid map library for mobile robotic mapping that can be used as the basis of environmental models and various forms of grid maps available in ROS 1. This library is one of the top downloaded ROS packages. Your task will be to work with the community and the mentor to port grid_maps metapackage from ROS 1 to ROS 2 and help develop the next generation environment model in ROS 2 to replace costmap_2d.
 
 This will involve porting code from ROS 1 to ROS 2, analyzing uses of the environmental model to define an abstract interface to allow replacement of costmap_2d with grid_map, and building up the basic grid-operations for costmaps. It is not expected to complete the full new model with sensor processing over the course of the summer. If completed early, you may be able to help design a gradient model to complement your implemented costmap model using grid_maps. This will allow robots to select a gradient or a costmap model on startup.
@@ -33,7 +33,7 @@ This will involve porting code from ROS 1 to ROS 2, analyzing uses of the enviro
 - Coordinate transformations and basic geometry
 - Recommended: Gazebo simulation and Navigation experience
 
-**List of relevant open source software repositories and refs** 
+**List of relevant open source software repositories and refs**
 
 - `ROS <https://www.ros.org/>`_
 - `Gazebo Simulator <http://gazebosim.org/>`_
@@ -44,4 +44,3 @@ This will involve porting code from ROS 1 to ROS 2, analyzing uses of the enviro
 **Licensing**
 - All contributions will be under the Apache 2.0 license.
 - No other CLA's are required.
-

2021summerOfCode/projects/localization.rst

@@ -6,16 +6,16 @@
 6. 2D/3D Localization Improvements
 ==================================
 
-**Task description** 
+**Task description**
 
-The Navigation2 stack uses AMCL as its primary localization engine. Over the last 10 years, essentially no updates to AMCL has been made. This is due to the code base for this implementation of an Adaptive Monte Carlo Localizer is written in embedded C, not well structured, and very sensitive to changes. A-MCL implementations have been a hallmark of localization for over a decade but this particular implementation should be deprecated. 
+The Navigation2 stack uses AMCL as its primary localization engine. Over the last 10 years, essentially no updates to AMCL has been made. This is due to the code base for this implementation of an Adaptive Monte Carlo Localizer is written in embedded C, not well structured, and very sensitive to changes. A-MCL implementations have been a hallmark of localization for over a decade but this particular implementation should be deprecated.
 
 Your target involves designing and creating a new localization engine for the Nav2 stack. The requirements of this are:
 - Support 2D laser scanners
 - Support 3D laser scanners, where 2D case could potentially be a simplified case
 - Accurately track the localization of a robot in a given occupancy grid
 
-The reason that specific method is left open-ended is to allow for creativity, novelty, or reimplementation of a what you feel is best. We have, however, analyzed other MCL variants as being good options. This may include reimplementing an A-MCL that is designed to be modified with modular components and support sampling from a 3D lidar. Another option is a NDT-MCL using NDT 2D/3D scan matching. Other options may be proposed and discussed with mentors during the application phase. The task involves 3D as well since there is no standard 3D localizer in ROS 2 yet and more and more robust 3D SLAM libraries have emerged over the last 2 years. 
+The reason that specific method is left open-ended is to allow for creativity, novelty, or reimplementation of a what you feel is best. We have, however, analyzed other MCL variants as being good options. This may include reimplementing an A-MCL that is designed to be modified with modular components and support sampling from a 3D lidar. Another option is a NDT-MCL using NDT 2D/3D scan matching. Other options may be proposed and discussed with mentors during the application phase. The task involves 3D as well since there is no standard 3D localizer in ROS 2 yet and more and more robust 3D SLAM libraries have emerged over the last 2 years.
 
 An optional but recommended feature of this work would be to also accept the inputs from multiple laser scanners. However it is not strictly required.
 
@@ -38,7 +38,7 @@ An optional but recommended feature of this work would be to also accept the inp
 - Ability to read and implement academic works
 - Recommended: Gazebo simulation and Navigation experience
 
-**List of relevant open source software repositories and refs** 
+**List of relevant open source software repositories and refs**
 
 - `ROS <https://www.ros.org/>`_
 - `Gazebo Simulator <http://gazebosim.org/>`_
@@ -48,6 +48,3 @@ An optional but recommended feature of this work would be to also accept the inp
 **Licensing**
 - All contributions will be under the Apache 2.0 license.
 - No other CLA's are required.
-
-
-

2021summerOfCode/projects/multithreading.rst

@@ -4,7 +4,7 @@
 4. Navigation MultiThreading
 ============================
 
-**Task description** 
+**Task description**
 
 The aim of this project is the significantly improve the run-time performance of Nav2 making sure to leverage the full capabilities of multi-processor core CPUs. We seek to identify areas in the Nav2 stack that could leverage multi-threading or parallel processing to speed up computations and improve overall user performance on a broad range of compute platforms.
 
@@ -19,7 +19,7 @@ Some examples include:
 
 We are seeking a student interested in learning about multi-threading and parallel processing, ideally with some exposure to these concepts and libraries already, to analyze potential areas for parallel computing. Then, select the top candidates and implement them with parallel processing and benchmark the improvements to the Nav2 stack they provide.
 
-This will be an excellent chance to apply (or obtain) C++ parallel computing skills while also learning a great deal about how to build mobile robot navigation systems -- both very valuable skillsets. 
+This will be an excellent chance to apply (or obtain) C++ parallel computing skills while also learning a great deal about how to build mobile robot navigation systems -- both very valuable skillsets.
 
 **Project difficulty: Medium**
 
@@ -39,7 +39,7 @@ This will be an excellent chance to apply (or obtain) C++ parallel computing ski
 - Working knowledge (or ability to quickly obtain) on one or more of: TBB, OpenMP, OpenCL, Cuda, and similar
 - Recommended: Gazebo simulation, ROS navigation
 
-**List of relevant open source software repositories and refs** 
+**List of relevant open source software repositories and refs**
 
 - `ROS <https://www.ros.org/>`_
 - `Gazebo Simulator <http://gazebosim.org/>`_