Skip to content

✨ Add CodeAuditor Rule to include Captions with Time Length to Videos #966

Description

@tiagov8

Requested by: @tiagov8 via YakShaver.ai 🦬
cc: @adamcogan, @jernejk, @zacharykeeping, @brookjeynes-ssw

Hi Team!

  🟥  Watch the video (2 min 45 sec)

  Url from screen share: https://yakshaver.ai

Pain

Implement a new feature in CodeAuditor that requires every video within content to have a caption ending with the video's time length. This feature aims to enhance accessibility and provide users with clear information about video duration.

Acceptance Criteria

  1. Every video within content must have a caption.
  2. The caption must end with the video's time length (e.g., '30 sec', '25 min', '1 h') as per https://www.ssw.com.au/rules/right-format-to-write-videos-time-length/.

Considerations

⚠️ Warning: Requiring all videos to have captions and show their duration may cause unintended issues:

  1. Development overload – Many websites (e.g., those using TinaCMS) use video blocks that aren’t designed to support captions. Enforcing this rule would create extra work for teams to modify existing content
  2. False positives – On many promotional pages, videos are decorative or purely visual. Forcing captions on these may disrupt the intended design and user experience

Screenshot

Screenshot
Figure: Video captions and video time length should be enforced by CodeAuditor

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions