Keh 2606 team best practice update

.github/pull_request_template.md

@@ -1,38 +1,37 @@
-# What type of PR is this? (check all applicable)
+<!-- markdownlint-disable MD041 -->
 
-- [ ] Refactor
-- [ ] Feature
-- [ ] Bug Fix
-- [ ] Optimization
-- [ ] Documentation Update
+## Overview
 
-## What
+<!-- Provide an overview of the changes in this pull request -->
 
-Describe what you have changed and why.
+## Related Issues
 
-### Testing
+<!-- List any related issues or pull requests here -->
+<!-- This can include issues from Jira but make sure *not* to link them -->
 
-Have any new tests been added as part of this issue? If not, try to explain why test coverage is not needed here.
+## Testing
 
-- [ ] Yes
-- [ ] No
-      Please write a brief description of why test coverage is not necessary here.
-- [ ] Not as part of this ticket. (Could be done at a later point)
+<!-- Describe how to test the changes in this pull request -->
 
-### Documentation
+## Checklist
 
-Has any new documentation been written as part of this issue? We should try to keep documentation up to date
-as new code is added, rather than leaving it for the future.
+<!-- Please check off the following items before submitting this pull request -->
+<!-- If anything is not applicable, please explain why in the exemptions section -->
 
-- [ ] Yes
-- [ ] No
-      Please write a brief description of why documentation is not necessary here.
-- [ ] Not as part of this ticket. (Could be done at a later point)
+- [ ] I have reviewed the changes in this pull request
+- [ ] I have tested the changes locally
+- [ ] I have updated/created any relevant documentation
+- [ ] I have updated/created any relevant tests
+- [ ] All CI checks have passed
+- [ ] I have used a development Concourse pipeline to test the changes within a development environment
+- [ ] I have added any necessary labels to this pull request
+- [ ] I have assigned myself to this pull request
+- [ ] I have assigned the appropriate reviewers to this pull request
 
-### Related issues
+### Exemptions
 
-Provide links to any related issues.
+<!-- If any of the above checklist items are not applicable, please explain why here -->
 
-### How to review
+## Additional Notes
 
-Describe the steps required to test the changes.
+<!-- Add any additional notes or comments here -->

.github/workflows/ci-docs.yml

@@ -0,0 +1,53 @@
+---
+name: Documentation CI
+on:
+  push:
+    branches: [main]
+    paths: [docs/**]
+  pull_request:
+    branches: [main]
+    paths: [docs/**]
+permissions:
+  contents: read
+jobs:
+  lint-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # V4.3.1
+        with:
+          persist-credentials: false
+      - name: Set up Node.js
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # V5
+        with:
+          node-version: "24"
+      - name: Install markdownlint
+        run: |
+          npm install -g markdownlint-cli
+      - name: Run markdownlint
+        run: |
+          markdownlint ./docs/**/*.md
+  verify-build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # V4.3.1
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # V5.6.0
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # V4.3.0
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install poetry
+      - run: poetry config virtualenvs.create false
+      - run: poetry install --only docs
+      - run: mkdocs build

.github/workflows/ci-fmt.yml

@@ -0,0 +1,39 @@
+---
+name: Linting and Formatting
+on:
+  push:
+    branches: [main]
+    paths:
+      - src/**
+      - tests/**
+  pull_request:
+    branches: [main]
+    paths:
+      - src/**
+      - tests/**
+permissions:
+  contents: read
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # V4.3.1
+        with:
+          persist-credentials: false
+      - name: Install Poetry
+        run: |
+          pip install poetry
+      - name: Set up Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # V5.6.0
+        with:
+          python-version-file: ".python-version"
+          cache: poetry
+      - name: Install dependencies
+        run: |
+          make install-dev
+      - name: Run linters
+        run: |
+          make lint

.github/workflows/ci-test.yml

@@ -0,0 +1,43 @@
+---
+name: Testing
+on:
+  push:
+    branches: [main]
+    paths:
+      - src/**
+      - tests/**
+  pull_request:
+    branches: [main]
+    paths:
+      - src/**
+      - tests/**
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+        with:
+          persist-credentials: false
+      - name: Install Poetry
+        run: pip install poetry
+
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+        with:
+          persist-credentials: false
+      - name: Set up Node.js
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5 release
+        with:
+          node-version: "24"
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - name: Test
+        run: make test
+
+    # Add more test jobs as needed, such as integration tests, end-to-end tests, etc.