Repository Guidelines

Project Structure & Module Organization

```
frontend/
```
houses the web demo.
```
index.html
```
,
```
styles.css
```
, and
```
main.js
```
implement the donor UI;
```
./frontend/data
```
stores static datasets.
```
indexing/
```
contains scripts and data for the Glean indexing agent.
```
index_transcripts.py
```
loads JSON call transcripts from
```
./frontend/data
```
.
Top-level directories stay lightweight; create new functionality inside those two roots unless there is a compelling reason otherwise.

Build, Test, and Development Commands

Serve the frontend locally with
```
python3 -m http.server 8000 --directory frontend
```
. This mirrors production’s static hosting.

Validate the indexing script without sending data by running

python3 indexing/index_transcripts.py --datasource <id> --data-dir ./frontend/data --view-url-base <url> --dry-run

Use the same command without
```
--dry-run
```
only after verifying environment variables (
```
GLEAN_INSTANCE
```
,
```
GLEAN_API_TOKEN
```
) are set.

Coding Style & Naming Conventions

Prefer modern ES modules and keep JavaScript functions small and composable; default indent is two spaces in HTML/CSS and two spaces in JS.
JSON data files use two-space indentation and camelCase keys (e.g.,
```
firstName
```
,
```
donationHistory
```
).
Avoid introducing build systems or external dependencies unless discussed; the demo is intentionally framework-free.

Testing Guidelines

Frontend changes should be verified manually in the browser; document any checked scenarios (table selection, sidebar behavior) in PR notes.
For indexing updates, run the script with
```
--dry-run
```
against sample data and capture console output to confirm payloads.
If you add automated tests, co-locate them (e.g.,
```
frontend/__tests__/
```
) and note the runner in this guide.

Commit & Pull Request Guidelines

Write imperative, present-tense commit messages (
```
Add donor recommendations panel
```
).
PRs should summarize scope, list manual test steps, and reference related tickets. Include screenshots or GIFs for UI changes and console excerpts for indexing or SDK work.

Project Structure & Module Organization

frontend/

houses the web demo.

index.html

styles.css

, and

main.js

implement the donor UI;

./frontend/data

stores static datasets.

indexing/

contains scripts and data for the Glean indexing agent.

index_transcripts.py

loads JSON call transcripts from

./frontend/data

Top-level directories stay lightweight; create new functionality inside those two roots unless there is a compelling reason otherwise.

Build, Test, and Development Commands

Serve the frontend locally with

python3 -m http.server 8000 --directory frontend

. This mirrors production’s static hosting.

Validate the indexing script without sending data by running

python3 indexing/index_transcripts.py --datasource <id> --data-dir ./frontend/data --view-url-base <url> --dry-run

Use the same command without

--dry-run

only after verifying environment variables (

GLEAN_INSTANCE

GLEAN_API_TOKEN

) are set.

Coding Style & Naming Conventions

Prefer modern ES modules and keep JavaScript functions small and composable; default indent is two spaces in HTML/CSS and two spaces in JS.

JSON data files use two-space indentation and camelCase keys (e.g.,

firstName

donationHistory

Avoid introducing build systems or external dependencies unless discussed; the demo is intentionally framework-free.

Testing Guidelines

Frontend changes should be verified manually in the browser; document any checked scenarios (table selection, sidebar behavior) in PR notes.

For indexing updates, run the script with

--dry-run

against sample data and capture console output to confirm payloads.

If you add automated tests, co-locate them (e.g.,

frontend/__tests__/

) and note the runner in this guide.

Repository Guidelines

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Related Skills

Nano Banana Pro

Markdown Converter

1password

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines