Fix the Issue of Code sanitisation #159 and Updated the contributting.md

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.18
+current_version = 0.9.0
 commit = True
 tag = True
 

.github/workflows/cypress.yml

@@ -1,5 +1,11 @@
-name: Cypress 🌲 
-on: [push, pull_request]
+name: Cypress Testing 🌲
+on:
+  push:
+    branches:
+      - development
+  pull_request:
+    branches:
+      - development
 jobs:
   cypress:
     runs-on: ubuntu-latest

.github/workflows/deploy.yml

@@ -1,46 +1,31 @@
 # .github/workflows/deploy.yml
 name: Deploy 🚀 Clima to Google Cloud Run (☁🏃)
+
 on:
   push:
     branches:
       - main
+
 jobs:
   deploy:
     name: Deploying 🚀 Clima
     runs-on: ubuntu-latest
-    if: "contains(github.event.head_commit.message, 'bump version')"
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - name: Setup python
-        uses: actions/setup-python@v4
+      - id: auth
+        uses: google-github-actions/auth@v2
         with:
-          python-version: '3.11'
-
-      - name: Export gcloud related env variable
-        run: export CLOUDSDK_PYTHON="/usr/bin/python3"
+          credentials_json: ${{ secrets.GCP_SA_KEY_JSON }}
 
-      # Build and push image to Google Container Registry
-      - name: Setting up
-        uses: google-github-actions/setup-gcloud@v0
+      - name: Set up Cloud SDK
+        uses: google-github-actions/setup-gcloud@v1
         with:
-          version: '318.0.0'
-          service_account_key: ${{ secrets.GCP_SA_KEY_JSON }}
-          service_account_email: "federico.tartarini@bears-berkeley.sg"
-          project_id: clima-316917
+          project_id: heat-stress-scale
 
-      - name: Building (🏗️)
-        run: |-
+      - name: Building (🏗️) and Deploying (🚀)
+        run: |
           gcloud builds submit \
-            --tag us-docker.pkg.dev/clima-316917/gcr.io/clima
-
-      # Setup gcloud CLI
-      - name: Deploy (🚀)
-        uses: google-github-actions/deploy-cloudrun@v1
-        with:
-          service: clima
-          image: us-docker.pkg.dev/clima-316917/gcr.io/clima
-          region: us-central1
-          credentials: ${{ secrets.GCP_SA_KEY_JSON }}
-          project_id: clima-316917
+          --project=clima-316917 \
+          --substitutions=_REPO_NAME="clima",_PROJ_NAME="clima-316917",_IMG_NAME="main",_GCR="us.gcr.io",_REGION="us-central1",_MEMORY="4Gi",_CPU="2"

.github/workflows/python.yml

@@ -1,5 +1,11 @@
-name: Python 🐍 
-on: [push, pull_request]
+name: Python Testing 🐍
+on:
+  push:
+    branches:
+      - development
+  pull_request:
+    branches:
+      - development
 jobs:
   pytest:
     runs-on: ubuntu-latest
@@ -17,13 +23,14 @@ jobs:
           pip install pipenv
           pipenv install --dev
 
-      - name: Test Clima
+      - name: Ruff Check
         run: |-
-          pipenv run python -m pytest
+          pipenv run ruff check . --output-format=github
+
+      - name: Ruff Format (verify)
+        run: |-
+          pipenv run ruff format --check .
 
-      - name: Run Black
-        # TODO: Add to dev dependencies: Adding it right now
-        # bumps other dependencies and the application won't run.
+      - name: Test Clima
         run: |-
-          pip install black
-          black . --check
+          pipenv run python -m pytest

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.9
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

Pipfile

@@ -23,6 +23,7 @@ pytest = "*"
 bump2version = "*"
 black = "*"
 ruff = "*"
+pre-commit = "*"
 
 [requires]
 python_version = "3.11"

assets/manifest.json

@@ -467,7 +467,7 @@
   "orientation": "portrait",
   "background_color": "#ffffff",
   "display": "standalone",
-  "id": "0.8.18",
+  "id": "0.9.0",
   "description": "CBE Clima Tool: a free and open-source web application for climate analysis tailored to sustainable building design",
   "start_url": "/",
   "scope": "/",

cloudbuild.yaml

@@ -12,4 +12,4 @@ steps:
          '--image', '$_GCR/$_PROJ_NAME/$_REPO_NAME/$_IMG_NAME',
          '--region', '$_REGION',
          '--memory', '$_MEMORY',
-         '--cpu', '$_CPU',]
+         '--cpu', '$_CPU']

config.py

@@ -61,21 +61,21 @@ class PageInfo:
     TEMP_RH_NAME = "Temperature and Humidity"
     TEMP_RH_ORDER = 2
     SOLAR_RADIATION_NAME = "Solar Radiation"
-    SOLAR_RADIATION_ORDER = 2
+    SOLAR_RADIATION_ORDER = 3
     SUN_NAME = "Sun and Clouds"
-    SUN_ORDER = 3
+    SUN_ORDER = 4
     WIND_NAME = "Wind"
-    WIND_ORDER = 4
+    WIND_ORDER = 5
     PSYCHROMETRIC_NAME = "Psychrometric Chart"
-    PSYCHROMETRIC_ORDER = 5
+    PSYCHROMETRIC_ORDER = 6
     NATURAL_VENTILATION_NAME = "Natural Ventilation"
-    NATURAL_VENTILATION_ORDER = 6
+    NATURAL_VENTILATION_ORDER = 7
     UTCI_NAME = "Outdoor Comfort"
-    UTCI_ORDER = 7
+    UTCI_ORDER = 8
     EXPLORER_NAME = "Data Explorer"
-    EXPLORER_ORDER = 8
+    EXPLORER_ORDER = 9
     CHANGELOG_NAME = "Changelog"
-    CHANGELOG_ORDER = 9
+    CHANGELOG_ORDER = 10
     NOT_FOUND_NAME = "404"
 
 

docs/README.md

@@ -10,14 +10,16 @@ The CBE Clima Tool is a web-based application built to support climate analysis
 
 The CBE Clima Tool is open source. We have released the source code on a [public repository](https://github.com/CenterForTheBuiltEnvironment/clima). We welcome contributions from the community ([more info here](contributing/contributing.md)).
 
-### Video Tutorial
+## Video Tutorial
 
 Learn more about the CBE Clima Tool by watching the following video.
 
 {% embed url="https://www.youtube.com/watch?v=VJ_wOHadVdw" %}
 CBE Clima tool tutorial and overview
 {% endembed %}
 
+[Watch on YouTube](https://www.youtube.com/watch?v=VJ_wOHadVdw)
+
 ## Contributions
 
 This ongoing project results from the collaboration and contributions of the people listed below.

docs/contributing/contributing.md

@@ -5,11 +5,72 @@ description: Guide on how to contribute to this project
 # How to contribute
 
 First off, thanks for taking the time to contribute!
+We use GitHub as our main collaboration platform. Please work from the `development` branch, create small feature branches, and open focused pull requests. Follow Conventional Commit messages (e.g., `feat:`, `fix:`, `docs:`), format Python code with Black, and add tests where needed. Never merge your own PR—wait for review and address all comments (including AI reviewer suggestions). Use Issues and Projects to track tasks and discussions.
+
+> This project requires Python 3.11. Do not use Python 3.12 or newer, as it may cause dependency incompatibilities, build failure or runtime errors
+
 
 ## General Feedback
 
 If you have a general feedback about our project, please do not open an issue but instead please fill in this [form](https://forms.gle/LRUq3vsFnE1QCLiA6)
 
+## Fork & branch processing
+
+First fork the origin repository to your own github repository, then clone the repository to your local computer.
+
+```bash
+git clone https://github.com/Your Account name/clima.git
+cd clima
+```
+
+Set up the upstream repository and check the output repositories.
+
+```bash
+git remote add upstream https://github.com/CenterForTheBuiltEnvironment/clima.git
+
+git remote -v
+```
+
+The terminal should output a list:
+
+- `origin → your Fork repository`
+- `upstream → origin repository`
+
+Check all branches.
+
+```bash
+git branch -a
+```
+
+The terminal will show a list of branches:
+
+```bash
+> * main
+  	remotes/origin/HEAD -> origin/main
+  	remotes/origin/development
+  	remotes/origin/main
+```
+
+Pull the development branch first, and if the terminal does not notice you that you should try the second command.
+
+```bash
+git checktout development
+
+git checkout -b development origin/development
+```
+
+Create a new branch in the development branch.
+
+```bash
+git checkout -b (your branch name)
+```
+
+Finally update and push to your repository branch if you modify the files.
+
+```bash
+git push origin (your branch name)
+```
+
 ## Code of Conduct
 
 Available [here](code_of_conduct.md)
@@ -18,6 +79,57 @@ Available [here](code_of_conduct.md)
 
 We use Black.exe to format the code.
 
+Install Black:
+
+We use ruff to enforce the code style and code formatting. You can run it with:
+
+```bash
+pipenv run ruff check .
+pipenv run ruff format .
+```
+
+To ensure that the code is formatted correctly, we use a pre-commit hook that runs Ruff before every commit.
+Run the following once to enable hooks in your local repo:
+
+```bash
+pipenv run pre-commit install
+# optional: run on all files
+pipenv run pre-commit run --all-files
+```
+
+Hence, you will need to make sure that the code is formatted correctly before committing your changes; otherwise, the commit will fail.
+More information about pre-commit hooks can be found [here](https://pre-commit.com/).
+
+```bash
+pipenv install black
+```
+
+Format your code before committing:
+
+```bash
+black .
+```
+
+## Testing
+
+Before submitting a Pull Request, please make sure:
+- All tests should pass.
+- You have installed project dependencies:
+
+```bash
+npm install
+
+pipenv install -r requirements.txt
+```
+
+From the root directory, run:
+
+```bash
+cd tests/node
+
+npx cypress run
+```
+
 ## Submitting changes
 
 Please send a Pull Request with a clear list of what you've done. Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
@@ -28,6 +140,43 @@ $ git commit -m "A brief summary of the commit
 > A paragraph describing what changed and its impact."
 ```
 
+> Detailed requirements for submitting a PR are described in the [Pull Request Regulation](#pull-request-regulation) section below
+
+Classification of Common Commit Types:
+
+- `Main (Master)`: Stable branch, merge code that passes review and CI; merge and release every time,
+- `Develop`: Continuous Integration branch for daily integration with multiple collaborators.
+- `Feature/*`: feature development branch, cut out from main or develop, send PR to merge in after completing the feature.
+- `Fix/*`: defect repair branch, the same process as feature
+- `Release/*`: release preparation branch for freezing versions, fixing documentation, doing regressions and tagging.
+- `docs/*`, `chore/*`, `refactor/*`, `test/*`: documentation, miscellaneous, refactor, test type branches.
+- `Style`: style modification (does not affect the function): code formatting, space adjustment, naming rules unity.
+- `Refactor`: Code Refactoring: Refactor existing code to improve maintainability.
+- `Test`: Add or modify tests: add unit tests, integration tests, or modify test logic.
+- `Chore`: Build Configuration, Dependency Management, CI/CD Configuration Updates.
+- `Perf`: Performance Optimisation: Optimising code execution efficiency or memory usage.
+- `Ci`: CI Configuration Related: Changing Continuous Integration Configurations for Github Actions, Travis, Jenkins, etc.
+- `Build`: build system related: modify build scripts, packaging configuration.
+- `Revert`: Rollback Commit: Undoing a Previous Commit
+- `Security`: Security fixes, fixing security vulnerabilities, updating dependencies to prevent attacks.
+- `Deps`: Dependency Management: Dependency Management/Adding, updating, and removing dependency libraries
+- `Infra`: Infrastructure related: changes to development environments, containers, server configurations, etc.
+
+## Pull Request Regulation
+**Time to submit PR:**
+
+- User requirements/issues have been addressed or discussed in Issue and consensus has been reached.
+- Changes have been minimised (small steps/phased submission) to avoid "mega PRs".
+
+**The pull request should include the following information:**
+
+- **Description:** Provide a brief summary of the changes, related issues, and motivation. List any required dependencies. **Fixes # (issue)**
+
+- **Type of Change:** Bug fix (non-breaking); New feature (non-breaking); Breaking change; Documentation update.
+
+- **Testing:** Describe how you tested your changes and how we can reproduce them. Include test details if necessary.
+
+
 ## Thanks
 
 Thank you again for being interested in this project! You are awesome!

docs/contributing/run-project-locally.md

@@ -27,7 +27,7 @@ This guide is for Mac OSX, Linux, or Windows.
 2. **Create a virtual environment using pipenv and install dependencies:**
 
    ```text
-    pipenv install <name-of-the-package>
+    pipenv install --dev
    ```
 
 3.  **Run tool locally**

docs/documentation/tabs-explained/README.md

@@ -8,7 +8,7 @@ description: >-
 
 The Clima app is organized in a series of tabs that allow the exploration of various topics. All the tabs other than "Select Weather File" are active after a weather file has been selected.
 
-Although there is a logical sequence in the organization of the tabs, thy can be accessed in any order.  
+Although there is a logical sequence in the organization of the tabs, thy can be accessed in any order.
 
 The Followin section will explain the content and the usage of each tab.