feat: enforce conventional commits

.github/workflows/backend-battery.yml → .github/workflows/backend-battery.yml.disabled

@@ -1,6 +1,8 @@
-name: Run Battery of Checks for Backend
+name: Linting and Testing
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches: [ main ]
 
 jobs:
   battery:
@@ -32,19 +34,19 @@ jobs:
         pip install poetry
         poetry install --no-root --with dev
 
-    # - name: Ruff & Isort Check
-    #   run: |
-    #     poetry run ruff check ./src
-    #     poetry run isort --check-only ./src
+    - name: Ruff & Isort Check
+      run: |
+        poetry run ruff check ./src
+        poetry run isort --check-only ./src
 
-    # - name: Type check
-    #   run: poetry run pyright
+    - name: Type check
+      run: poetry run pyright
 
-    # - name: Run Tests & Coverage
-    #   run: poetry run pytest --cov=./src --cov-report=xml
+    - name: Run Tests & Coverage
+      run: poetry run pytest --cov=./src --cov-report=xml
 
-    # - name: Upload Coverage Report to Codecov
-    #   uses: codecov/[email protected]
-    #   with:
-    #     token: ${{ secrets.CODECOV_TOKEN }}
-    #     file: ./coverage.xml
+    - name: Upload Coverage Report to Codecov
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        file: ./coverage.xml

.github/workflows/conventional-commits.yml

@@ -0,0 +1,16 @@
+name: Conventional Commits
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Conventional Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: webiny/[email protected]
+        #with:
+          #GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Optional, for private repositories.
+          #allowed-commit-types: "feat,fix," # Optional, set if you want a subset of commit types to be allowed.

README.md

@@ -339,7 +339,7 @@ We welcome contributions from the community! To ensure a smooth collaboration, p
 ### Submitting Changes
 
 1. **Open an Issue**: For major changes, start by opening an issue to discuss your proposed modifications. This helps us understand your intentions and provide feedback early in the process.
-2. **Pull Requests**: Once your changes are ready, submit a pull request. Ensure your code adheres to our coding standards and passes all tests.
+2. **Pull Requests**: Once your changes are ready, submit a pull request. Ensure your code adheres to our coding standards and passes all tests. Commits should follow [conventional-commits](https://www.conventionalcommits.org/) specification.
 
 ### Code Formatting