Alt text for images in posts

Abierto
#124 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
react, typescript

Línea de trabajo

Start with createPostSchema in packages/shared/src/index.ts, then the Post model in apps/api/src/models/Post.ts, and the image in apps/web/src/components/PostCard.tsx near line 135 where the img alt is set. Add the optional trimmed imageAlt field to the schema and model, return it from the API, and add it to the composer in Composer.tsx. Done when schema tests cover too-long and empty input, the API response includes the field, and the card falls back to the current alt text when it is missing.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

accessibility api enhancement help wanted web

Difficulty: Intermediate · Estimated size: 1 day

Context

Post images get a generic alt text (Image posted by @name), so people who use screen readers cannot tell what the picture shows.

Problem or goal

Let authors describe their image when they post it.

Suggested approach

  • Shared: add an optional imageAlt (max 300 characters) to the create-post schema and PostDTO.
  • API: store it on Post and return it. It is not editable if the image is not editable.
  • Web: an "Add description" field under the image preview in the composer, with a counter. Use it as the alt text in PostCard and fall back to the current text.

Where to look

  • apps/web/src/components/Composer.tsx
  • apps/web/src/components/PostCard.tsx (the <img alt> near line 135)
  • packages/shared/src/index.ts (createPostSchema)
  • apps/api/src/models/Post.ts

Acceptance criteria

  • A description is optional and trimmed.
  • The alt text is escaped by React like any other text.
  • Existing posts keep working.
  • Tests cover the schema (too long, empty) and the API response.

How to work on it

  1. Comment here to claim it, so two people do not do the same work.
  2. Fork the repo and branch from main (feat/short-name or fix/short-name). Setup steps are in docs/DEVELOPMENT.md.
  3. Keep the change focused and add tests for backend logic.
  4. Run npm run typecheck, npm test and npm run lint and npm run format before opening the pull request.
  5. Use a Conventional Commits title (for example feat(web): add bookmarks). More in CONTRIBUTING.md.

Stuck? Ask in this issue. Questions are welcome.


Generated by Claude Code

Lenguaje dominante
TypeScript
Estrellas
6
Forks
6
Merge medio
1 h 59 min
PR fusionados (30 d)
59

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Haseeb-MernStack/commune

Todos los issues de Haseeb-MernStack/commune

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.