docs: Add contributing guidelines

.ci/create-spec.py

@@ -51,7 +51,14 @@
     ICON = join(ASSETS, "icon.png")
     I18NS = str(ROOT_PATH / "src" / "i18n")
 
-    BUILDER_ARGS = [ ]
+    if SYSTEM == "Darwin":
+        ICON = join(ASSETS, "icon.icns")
+    elif SYSTEM == "Windows":
+        ICON = join(ASSETS, "icon.ico")
+    else:
+        ICON = join(ASSETS, "icon.png")
+
+    BUILDER_ARGS = []
 
     # The app name
     BUILDER_ARGS.append(f"--name={PYNAME}")
@@ -67,38 +74,37 @@
     if SYSTEM == "Linux":
         # Tha application is a GUI
         BUILDER_ARGS.append("--onefile")
-    
+
     elif SYSTEM == "Windows":
         # Tha application is a GUI with a hidden console
         # to keep `sys` module enabled (necessary for Kboot)
         BUILDER_ARGS.append("--onefile")
         BUILDER_ARGS.append("--console")
         BUILDER_ARGS.append("--hidden-import=win32timezone")
         BUILDER_ARGS.append("--hide-console=minimize-early")
-        
+
     elif SYSTEM == "Darwin":
         # Tha application is a GUI in a bundled .app
         BUILDER_ARGS.append("--onefile")
         BUILDER_ARGS.append("--noconsole")
-        
+
         # For darwin system, will be necessary
         # to add a hidden import for ssl
         # (necessary for request module)
         BUILDER_ARGS.append("--hidden-import=ssl")
-        BUILDER_ARGS.append("--hidden-import=pillow")
         BUILDER_ARGS.append("--optimize=2")
 
     # Necessary for get version and
     # another infos in application
     BUILDER_ARGS.append("--add-data=pyproject.toml:.")
-    
-    # some assets 
+
+    # some assets
     for f in listdir(ASSETS):
         asset = join(ASSETS, f)
         if isfile(asset):
             if asset.endswith("png") or asset.endswith("gif") or asset.endswith("ttf"):
-                BUILDER_ARGS.append(f"--add-data={asset}:assets")                
-        
+                BUILDER_ARGS.append(f"--add-data={asset}:assets")
+
     # Add i18n translations
     for f in listdir(I18NS):
         i18n_abs = join(I18NS, f)
@@ -107,7 +113,6 @@
             if findall(r"^[a-z]+\_[A-Z]+\.UTF-8\.json$", f):
                 BUILDER_ARGS.append(f"--add-data={i18n_abs}:{i18n_rel}")
 
-
     args = p.parse_args(BUILDER_ARGS)
 
     # Now generate spec

.github/workflows/build.yml

@@ -1,12 +1,14 @@
 name: Build
 
 on:
-  workflow_run:
-    workflows: Tests
-    types: completed
+  push:
     branches:
       - main
-      - '!develop'
+      - develop
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
 
 jobs:
 
@@ -25,7 +27,6 @@ jobs:
             arch: arm64
 
     runs-on: ${{ matrix.os }}
-    if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'main' }}
 
     steps:
 
@@ -230,7 +231,7 @@ jobs:
 
       - name: Upload artifact deb (Linux)
         if: ${{ runner.os == 'Linux' }}
-        uses: actions/upload-artifact@v5         
+        uses: actions/upload-artifact@v7         
         with:
           name: ${{ steps.release-deb.outputs.pkg }}
           path: |
@@ -239,7 +240,7 @@ jobs:
 
       - name: Upload artifact rpm (Linux)
         if: ${{ runner.os == 'Linux' }}
-        uses: actions/upload-artifact@v5         
+        uses: actions/upload-artifact@v7         
         with:
           name: ${{ steps.release-rpm.outputs.pkg }}
           path: |
@@ -248,7 +249,7 @@ jobs:
 
       - name: Upload artifacts (MacOS)
         if: ${{ runner.os == 'macOS' }}
-        uses: actions/upload-artifact@v5         
+        uses: actions/upload-artifact@v7         
         with:
           name: ${{ steps.release-macos.outputs.pkg }}
           path: |
@@ -257,7 +258,7 @@ jobs:
 
       - name: Upload artifacts (Windows)
         if: ${{ runner.os == 'Windows' }}
-        uses: actions/upload-artifact@v5         
+        uses: actions/upload-artifact@v7         
         with:
           name: ${{ steps.release-windows.outputs.pkg }}
           path: |

.github/workflows/conventional-commits.yml

@@ -0,0 +1,13 @@
+name: Conventional Commits
+
+on:
+  pull_request: # We only need to check commit messages in PRs
+
+jobs:
+  conventional-commits:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: webiny/action-conventional-commits@v1.3.1
+        with:
+          allowed-commit-types: "feat,fix,docs,style,refactor,test,i18n,ci,chore"

.pylint/src

@@ -101,7 +101,7 @@ source-roots=
 
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
+# suggestion-mode=yes
 
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.

.pylint/tests

@@ -101,7 +101,7 @@ source-roots=
 
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
+# suggestion-mode=yes
 
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.

CHANGELOG.md

@@ -1,65 +1,63 @@
-# CHANGELOG
-
-## 0.0.20
+# 0.0.20
 
 - Automatic check of latest official firmware;
 - Optional selection of older firmware versions;
-- Supported devices: M5stickV, Sipeed Amigo, Sipeed Bit, Sipeed Dock, Sipeed Cube, Yahboom,
-WonderMV;
+- Supported devices: M5stickV, Sipeed Amigo, Sipeed Bit, Sipeed Dock,
+  Sipeed Cube, Yahboom and WonderMV;
 - Flash official firmware with automatic integrity/authenticity verification;
-- Flash beta firmware  devices;
-- Air-gap update devices with SDcard;
+- Flash beta firmware devices;
+- Air-gapped update devices with SDcard;
 - Wipe devices;
 - 12 locale support;
 - support for Windows, MacOS Arm, MacOS Intel, Debian-like OS and Fedora;
 - Fixed Fedora crashes;
 - Better error handling during flash procedure;
 - Better error handling during wipe procedure;
-- Better error handling during air-gap update procedure;
+- Better error handling during air-gapped update procedure;
 
 ## 0.0.20-beta
 
-**Major update**
+### Major update
 
-* make an airgapped update: 
-  * user will be requested to insert a SDCard on computer;
-  * user can select among recognized removable drives;
-  * both `firmware.bin` and `firmware.bin.sig` will be copied to sdcard;
-  * after the copy, user will be requested to eject sdcard and insert it on device;
-  * at same time, the `firmware.bin`'s  computed hash will appear to compare with the computed hash
-  on device;
+- Make an air-gapped update:
+  - user will be requested to insert a SDCard on computer;
+  - user can select among recognized removable drives;
+  - both `firmware.bin` and `firmware.bin.sig` will be copied to sdcard;
+  - after the copy, user will be requested to eject sdcard and insert it on
+    device;
+  - at same time, the `firmware.bin`'s computed hash will appear to compare
+    with the computed hash
+    on device;
 
-**Minor updates**
+### Minor updates
 
-* added support to de_DE locale;
-* added support to ja_JP locale;
-* fixes on Windows bug that didn't allow users to select a custom asset folder;
+- Added support to de_DE locale;
+- Added support to ja_JP locale;
+- Fixed Windows bug that didn't allow users to select a custom asset folder;
 
 ## 0.0.20-alpha-3
 
-- Fix the bug that crash when a new firmware version is added on `selfcustody/krux`, but not it
-isnt a valid one in `VALID_DEVICES_VERSIONS`;
-- The fix suggested by @odudex to manage new versions (good when a hot fix is made) in line 101 of
-`src/app/screens/select_device_screen.py`;
+- Fix the bug that crash when a new firmware version is added on
+  `selfcustody/krux`, but it isn't listed as a valid one in
+  `VALID_DEVICES_VERSIONS`;
+- The fix suggested by @odudex to manage new versions (good when a hot fix is
+  made) in line 101 of `src/app/screens/select_device_screen.py`;
 
 ## 0.0.20-alpha-2
 
-- Changed the version from `0.0.2-alpha` to `0.0.20-alpha-2` as suggested by @odudex;
+- Changed the version from `0.0.2-alpha` to `0.0.20-alpha-2` as suggested by
+  @odudex;
 - Refactored the code a little bit to be more pythonic;
 - Removed startup messages as suggested by @tadeubas:
   - On linux the `GreetingsScreen` class will check:
     - if user is on `dialout`/`uucp` group (debian and fedora based / archlinux);
-    - internet connection
-  - On MacOS an Windows the `GreetingsScreen` class will check:
+  - On MacOS and Windows the `GreetingsScreen` class will check:
     - internet connection
 - Added the window resize behaviour;
 - Removed fullscreen on startup;
-- Fedora and Ubuntu:
-  - fixed desktop icon entry on `.ci/create-deb`;
-  - fixed desktop icon entry on `.ci/create-rpm`;
-- Added more tests:
-  - ask_permissions_dialout_screen;
-  - error_screen.
+- fixed desktop icon entry on `.ci/create-deb`;
+- fixed desktop icon entry on `.ci/create-rpm`;
+- Added more tests.
 
 ## 0.0.2-alpha
 
@@ -112,5 +110,5 @@ isnt a valid one in `VALID_DEVICES_VERSIONS`;
   - to suit `wdio-electron-service` major updates that break E2E tests;
   - renamed extensions to `mts` to suit `vite-plugin-electron`;
   - updated krux firmware version checks to `23.09.1`;
-- Updated `openssl` for windows to `3.2.0` *;
+- Updated `openssl` for Windows to `3.2.0`;
 - Removed MacOS release since the current approach did not worked well on MacOS;