Merge branch 'main' into dependabot/bundler/aws-sdk-s3-1.197.0

Author: rsmithlal

.github/copilot-instructions.md

@@ -0,0 +1,21 @@
+## Summary
+
+Describe the change and the motivation.
+
+## Checklist
+
+- [ ] Tests added/updated and passing (`bin/ci`).
+- [ ] Lint and security checks (`rubocop`, `brakeman`, `bundler-audit`).
+- [ ] Documentation updated under `docs/` describing new/changed functionality.
+- [ ] Mermaid diagrams (`docs/*.mmd`) updated to reflect changes.
+- [ ] Rendered PNGs regenerated with `bin/render_diagrams` and committed.
+- [ ] For DB changes, included any needed backfills/dedupes and noted risks.
+
+## Screenshots / Diagrams
+
+If applicable, include screenshots or link to updated diagrams.
+
+## Notes
+
+Anything reviewers should be aware of (migration order, flags, feature toggles).
+

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+name: Diagrams Check
+
+on:
+  pull_request:
+    branches: [ "**" ]
+
+jobs:
+  render-and-verify:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Render Mermaid diagrams
+        run: |
+          chmod +x bin/render_diagrams || true
+          ./bin/render_diagrams || true
+
+      - name: Verify rendered PNGs are up to date
+        run: |
+          CHANGED=$(git status --porcelain -- docs/diagrams/exports/png/*.png docs/diagrams/exports/svg/*.svg | wc -l)
+          if [ "$CHANGED" -gt 0 ]; then
+            echo "Diagram exports are out of date. Please run bin/render_diagrams and commit the updated files." >&2
+            echo "Changed files:" >&2
+            git status --porcelain -- docs/diagrams/exports/png/*.png docs/diagrams/exports/svg/*.svg >&2 || true
+            exit 1
+          fi
+        shell: bash
+

.github/workflows/diagrams.yml

@@ -0,0 +1,48 @@
+name: i18n Translation Health Report
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  i18n-health:
+    runs-on: ubuntu-latest
+    env:
+      # Ensure dev/test gems (incl. i18n-tasks) are installed
+      BUNDLE_WITHOUT: ""
+      BUNDLE_WITH: "development:test"
+    if: github.event_name == 'push' || github.event_name == 'pull_request'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        env:
+          # Ensure bundler installs dev/test groups during caching step
+          BUNDLE_WITHOUT: ""
+          BUNDLE_WITH: "development:test"
+        with:
+          ruby-version: '3.4.4'
+          bundler-cache: true
+      - name: Verify i18n-tasks
+        run: bundle exec i18n-tasks --version
+      - name: Normalize locale files
+        run: bin/i18n normalize
+      - name: Run i18n checks
+        run: bin/i18n check
+      - name: Upload i18n health report
+        if: always()
+        run: bin/i18n health > i18n-health.txt
+        continue-on-error: true
+      - name: Archive i18n health report
+        uses: actions/upload-artifact@v4
+        with:
+          name: i18n-health-report
+          path: i18n-health.txt
+    continue-on-error: true

.github/workflows/i18n-health.yml

@@ -87,6 +87,7 @@ jobs:
           echo "Waiting for Elasticsearch to be healthy..."
           curl -s "http://localhost:9200/_cluster/health?wait_for_status=yellow&timeout=60s" || (echo "Elasticsearch not healthy" && exit 1)
 
+
       - name: Run RSpec
         if: (matrix.rails == '7.1.5.2') || steps.update.outcome == 'success'
         env:
@@ -96,6 +97,14 @@ jobs:
           bundle exec rspec
         continue-on-error: ${{ matrix.allowed_failure }}
 
+      - name: Upload coverage report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-ruby-${{ matrix.ruby }}-rails-${{ matrix.rails }}
+          path: |
+            coverage/
+
       - name: Generate coverage badge
         if: ${{ github.ref == 'refs/heads/main' && success() }}
         continue-on-error: true

.github/workflows/rubyonrails.yml

@@ -0,0 +1,31 @@
+# Contributing
+
+Thank you for contributing to Better Together Community Engine!
+
+## Expectations for Changes
+
+- Tests: Keep tests green (`bin/ci`). Add/adjust specs for new behavior.
+- Lint & Security: Run `bundle exec rubocop`, `bundle exec brakeman -q -w2`, and `bundle exec bundler-audit --update`.
+- Documentation & Diagrams:
+  - Update or add docs under `docs/` for any new functionality, routes, background jobs, or changes to models/associations.
+  - Maintain Mermaid diagrams (`docs/*.mmd`) that reflect updated relationships and process flows.
+  - Render PNGs from `.mmd` using `bin/render_diagrams` and commit the outputs.
+  - PRs that change models, associations, or flows must include docs/diagram updates.
+- Accessibility, i18n, and policies: Follow AGENTS.md and `.github/instructions/*` guides.
+
+## Development
+
+- Use the setup in README/AGENTS.md (Docker or local).
+- Test app lives in `spec/dummy`.
+- For exchange (Joatu) features, see `docs/joatu/*` and `docs/exchange_process.md`.
+
+## Pull Requests
+
+- Keep PRs focused and small where possible.
+- Include a brief description of why, how, and impact.
+- If adding migrations: note any data backfills or dedupe steps.
+- If modifying notifications: describe dedupe/throttling strategy.
+
+## Questions
+
+Open a discussion or issue if you’re unsure about direction or scope.

AGENTS.md

@@ -113,6 +113,7 @@ group :test do
   gem 'rubocop-rspec_rails'
   # RSpec for unit testing
   gem 'rspec'
+  gem 'rspec-rebound'
   # RSpec Rails integration
   gem 'rspec-rails'
   # Selenium WebDriver for browser automation

CONTRIBUTING.md

@@ -262,7 +262,7 @@ GEM
       railties (>= 4.1.0)
       responders
       warden (~> 1.2.3)
-    devise-i18n (1.14.0)
+    devise-i18n (1.15.0)
       devise (>= 4.9.0)
       rails-i18n
     devise-jwt (0.12.1)
@@ -604,7 +604,7 @@ GEM
     reform-rails (0.2.6)
       activemodel (>= 5.0)
       reform (>= 2.3.1, < 3.0.0)
-    regexp_parser (2.11.1)
+    regexp_parser (2.11.2)
     reline (0.6.2)
       io-console (~> 0.5)
     representable (3.2.0)
@@ -642,6 +642,8 @@ GEM
       rspec-expectations (~> 3.13)
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
+    rspec-rebound (0.2.1)
+      rspec-core (~> 3.3)
     rspec-support (3.13.4)
     rswag (2.16.0)
       rswag-api (= 2.16.0)
@@ -678,7 +680,7 @@ GEM
     rubocop-factory_bot (2.27.1)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
-    rubocop-rails (2.33.1)
+    rubocop-rails (2.33.3)
       activesupport (>= 4.2.0)
       lint_roller (~> 1.1)
       rack (>= 1.1)
@@ -851,6 +853,7 @@ DEPENDENCIES
   redis (~> 5.4)
   rspec
   rspec-rails
+  rspec-rebound
   rswag
   rubocop
   rubocop-capybara

Gemfile

@@ -1,5 +1,7 @@
 # Better Together Community Engine
 
+[➡️ View the Documentation Index](docs/README.md)
+
 ## Overview
 
 The Better Together Community Engine is a transformative platform designed to unite communities through the power of collaboration and shared resources. Our core intention is to provide an inclusive, accessible space where individuals and groups from diverse backgrounds can come together to share knowledge, engage in meaningful dialogue, and develop innovative solutions to common challenges. By leveraging the collective wisdom and experience of its members, the platform aims to foster a culture of mutual support, learning, and sustainable growth.
@@ -10,6 +12,13 @@ This project embodies our vision of a world where collaboration leads to greater
 
 This project is the core community building portion of the Better Together platform.
 
+## Documentation
+
+For system overviews, flows, and diagrams, see the docs index:
+
+- docs: docs/README.md
+- Exchange (Joatu), Notifications, Models & Concerns, and more with Mermaid diagrams (PNG rendered).
+
 ## Dependencies
 
 In addition to other dependencies, the Better Together Community Engine relies on Action Text and Action Storage, which are part of the Rails framework. These dependencies are essential for handling rich text content and file storage within the platform.