Alt text for images in posts

オープン
#124 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
react, typescript

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
TypeScript
スター
6
フォーク
6
平均マージ
1時間 59分
マージ済み PR(30日)
59

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Haseeb-MernStack/commune のほかの issue

Haseeb-MernStack/commune の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。