Merge pull request #78 from brainelectronics/feature/improve-contribution-guideline

Add contribution guideline

Author: brainelectronics

.github/workflows/test.yml

@@ -40,10 +40,24 @@ jobs:
       - name: Lint with yamllint
         run: |
           yamllint .
-      - name: Install deploy dependencies
+      - name: Validate package version file
+        # the package version file has to be always up to date as mip is using
+        # the file directly from the repo. On a PyPi package the version file
+        # is updated and then packed
         run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
+          changelog2version \
+            --changelog_file changelog.md \
+            --version_file umodbus/version.py \
+            --version_file_type py \
+            --validate \
+            --debug
+      - name: Validate mip package file
+        run: |
+          upy-package \
+            --setup_file setup.py \
+            --package_changelog_file changelog.md \
+            --package_file package.json \
+            --validate
       - name: Execute tests
         run: |
           docker build --tag micropython-test --file Dockerfile.tests .
@@ -59,13 +73,12 @@ jobs:
       - name: Run Client/Host RTU test
         run: |
           docker compose -f docker-compose-rtu-test.yaml up --build --exit-code-from micropython-host
+      - name: Install deploy dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
       - name: Build package
         run: |
-          changelog2version \
-            --changelog_file changelog.md \
-            --version_file umodbus/version.py \
-            --version_file_type py \
-            --debug
           python setup.py sdist
           rm dist/*.orig
       - name: Test built package

.gitmodules

@@ -3,4 +3,4 @@
 	# changed to https due to RTD build issue
 	# see https://github.com/readthedocs/readthedocs.org/issues/4043
 	# url = git@github.com:brainelectronics/python-modules.git
-	url = https://github.com/brainelectronics/python-modules.git
+	url = https://github.com/brainelectronics/python-modules.git

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+---
+
+# To install pre-commit hooks, install `pre-commit` and activate it here:
+#     pip3 install pre-commit
+#     pre-commit install
+#
+default_stages:
+  - commit
+  - push
+  - manual
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+  - repo: https://github.com/brainelectronics/micropython-package-validation
+    rev: 0.5.0
+    hooks:
+      - id: upy-package
+        args:
+          - "--setup_file=setup.py"
+          - "--package_changelog_file=changelog.md"
+          - "--package_file=package.json"
+          - "--validate"
+  - repo: https://github.com/brainelectronics/changelog2version
+    rev: 0.10.0
+    hooks:
+      - id: changelog2version
+        args:
+          - "--changelog_file=changelog.md"
+          - "--version_file=umodbus/version.py"
+          - "--validate"

Dockerfile.client_rtu

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/rtu_client_example.py" ]

Dockerfile.client_tcp

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/tcp_client_example.py" ]

Dockerfile.host_rtu

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/rtu_host_example.py" ]

Dockerfile.host_tcp

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/tcp_host_example.py" ]

Dockerfile.test_examples

@@ -11,5 +11,3 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 # COPY mpy_unittest.py /root/.micropython/lib/mpy_unittest.py
-
-RUN micropython-dev -m upip install micropython-ulogging

Dockerfile.tests

@@ -12,8 +12,8 @@ COPY ./ /home
 COPY registers/example.json /home/tests/test-registers.json
 COPY umodbus /root/.micropython/lib/umodbus
 COPY mpy_unittest.py /root/.micropython/lib/mpy_unittest.py
+COPY tests/ulogging.py /root/.micropython/lib/ulogging.py
 
-RUN micropython-dev -m upip install micropython-ulogging
 RUN micropython-dev -c "import mpy_unittest as unittest; unittest.main('tests')"
 
 ENTRYPOINT ["/bin/bash"]

Dockerfile.tests_manually

@@ -12,7 +12,6 @@ COPY ./ /home
 COPY registers/example.json /home/tests/test-registers.json
 COPY umodbus /root/.micropython/lib/umodbus
 COPY mpy_unittest.py /root/.micropython/lib/mpy_unittest.py
-
-RUN micropython-dev -m upip install micropython-ulogging
+COPY tests/ulogging.py /root/.micropython/lib/ulogging.py
 
 ENTRYPOINT ["/bin/bash"]