Skip to content

Student name pronunciation#480

Open
mahigangal wants to merge 6 commits intomainfrom
mahi/student-name-pronunciation
Open

Student name pronunciation#480
mahigangal wants to merge 6 commits intomainfrom
mahi/student-name-pronunciation

Conversation

@mahigangal
Copy link
Collaborator

@mahigangal mahigangal commented Feb 23, 2026

Description

This PR adds support for an optional name pronunciation field so staff can see how a student’s name is said during queue interactions.

  • Added Name Pronunciation input in Profile Settings.
  • Added Name Pronunciation input during Legacy (email/password) registration.
  • Stored namePronunciation on user creation and profile update.
  • Added a migration for user_model.namePronunciation.
  • Displayed pronunciation on queue cards (staff side) as Name (Pronunciation) when available.
  • Displayed pronunciation in Course Roster next to the name when available.
  • Updated related tests and snapshots.

For queue display, I used inline text (Name (Pronunciation)) to keep this PR simple and readable on both desktop and mobile.
Alternative considered: a speaker icon with a tooltip for pronunciation. I did not implement that in this PR because tooltip-based interactions can be harder to use reliably on mobile (tap/hover behaviour and discoverability), and the queue page is already very busy. I can implement that option if preferred.

Motivation / Context: The main goal is to help staff pronounce student names correctly while helping students in the queue. The queue is the most important place for this, and roster support is included as a secondary display point.

Closes #85

Screenshots:

  1. Profile Settings with the new Name Pronunciation field.
Screenshot 2026-02-24 at 12 29 20 AM
  1. Legacy registration form with the new field.
Screenshot 2026-02-24 at 12 31 56 AM
  1. Queue card showing Student Name (Pronunciation) and Queue card without pronunciation (to show no visual clutter when empty).
Screenshot 2026-02-24 at 12 45 52 AM
  1. Course Roster row showing Name (Pronunciation).
Screenshot 2026-02-24 at 12 52 19 AM

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • This requires a run of yarn install
  • This change requires an addition/change to the production .env variables. These changes are below:
  • This change requires developers to add new .env variables. The file and variables needed are below:
  • This change requires a database query to update old data on production. This query is below:

How Has This Been Tested?

Manual Testing

  • Updated Name Pronunciation in Profile Settings and confirmed value is saved.
  • Registered a Legacy account with Name Pronunciation and confirmed value is saved.
  • Verified staff queue card shows Student Name (Pronunciation) when present.
  • Verified queue card shows only Student Name when pronunciation is empty.
  • Verified that the Name Pronunciation gets updated on the staff's side when the student changes it.
  • Verified Course Roster displays Name (Pronunciation) when present.

Automated Tests

  • Updated unit tests in auth.service.spec.ts, course.service.spec.ts, profile.service.spec.ts and queue.service.spec.ts.
  • Updated snapshots in auth.service.spec.ts.snap, queue.service.spec.ts.snap and profile.integration.ts.snap
  • Ran unit/integration tests locally and they passed.

Checklist:

  • I have performed a code review of my own code (under the "Files Changed" tab on github) to ensure nothing is committed that shouldn't be (e.g. leftover console.logs, leftover unused logic, or anything else that was accidentally committed)
  • I have commented my code where needed
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing tests pass locally with my changes
  • Any work that this PR is dependent on has been merged into the main branch
  • Any UI changes have been checked to work on desktop, tablet, and mobile

@mahigangal mahigangal linked an issue Feb 23, 2026 that may be closed by this pull request
@mahigangal mahigangal self-assigned this Feb 23, 2026
@mahigangal mahigangal marked this pull request as ready for review February 24, 2026 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Student name pronunciation

1 participant