Merge branch 'dhruv/prep-for-release' into 'main'

Resolve "Prepare repo for public release"

Closes #10

See merge request polymathrobotics/polymath_msgs!9

Author: Dhruv Tyagi

.github/media/polymath-robotics.png

@@ -0,0 +1,15 @@
+---
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/action@v3.0.1

.github/workflows/pre-commit.yml

@@ -1,3 +1,4 @@
+---
 include:
   - project: "polymathrobotics/ci/ci_templates"
     ref: main

.gitlab-ci.yml

@@ -0,0 +1,36 @@
+---
+repos:
+  # Generally useful checks provided by pre-commit
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: end-of-file-fixer
+      - id: forbid-submodules
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  # CMake
+  - repo: https://github.com/cmake-lint/cmake-lint
+    rev: 1.4.3
+    hooks:
+      - id: cmakelint
+        args: [--linelength=140]
+  # Bash / Shell scripts
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+        args: [-e, SC1091]
+  # YAML
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.29.0
+    hooks:
+      - id: yamllint
+        args: [-d, "{extends: default, rules: {line-length: {max: 150}}}"]

.pre-commit-config.yaml

@@ -1,2 +1,18 @@
+![Polymath Logo](.github/media/polymath-robotics.png)
+
+
 # polymath_msgs
 Interface definitions for customer applications to communicate with Polymath Autonomy Software
+
+Instructions and information on features that use these interface definitions can be found in the [Interface Control Document [Latest]](https://notion.polymathrobotics.com/general-application-interface-control-document)
+
+
+# Polymath Robotics
+### Superpowering autonomy programs
+
+Unlock the potential of your fleet with our streamlined, software-first approach — making autonomy development simpler, faster, and more cost-effective than ever before.
+
+For more information, visit [Polymath Robotics](https://www.polymathrobotics.com/)
+
+[Blog](https://www.polymathrobotics.com/blog) |
+[Podcast](https://www.automateitpod.com/)

README.md

@@ -5,7 +5,7 @@
   <version>0.0.2</version>
   <description>Interface definitions for customer applications to communicate with Polymath Autonomy Software</description>
   <maintainer email="dhruv@polymathrobotics.com">Dhruv Tyagi</maintainer>
-  <license>Proprietary</license>
+  <license>Apache-2.0</license>
 
   <buildtool_depend>ament_cmake</buildtool_depend>