Define what feature requirements info is needed for AI initiative issues

Created on 9 July 2025, 3 days ago

Problem/Motivation

We've updated the issue template recently for the AI module to have a bit more info, but we could provide more guidelines on what should be included for a feature request.

Proposed resolution

Create guidelines here:

  • TBD

Remaining tasks

  • Write up guidelines
  • Update issue template
  • Update contribution docs
📌 Task
Status

Active

Component

Planning

Created by

🇺🇸United States Kristen Pol Santa Cruz, CA, USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @Kristen Pol
  • 🇺🇸United States Kristen Pol Santa Cruz, CA, USA

    Assigning to Christoph for now

  • 🇩🇪Germany breidert

    @kristen I would suggest the following:

    Bug

    Title

    Clear, concise summary of the problem (e.g., "Crash on login when username is blank")

    Description

    - What’s happening vs. what’s expected?
    - Include any error messages, stack traces, or logs.
    - If it’s a regression, mention when it last worked.
    - Describe expected behavior

    Steps to Reproduce in Drupal AI DDEV environment

    1. Go to ‘...’
    2. Click on ‘...’
    3. See error

    Environment

    - Drupal version:
    - Drupal AI version:
    - Browser (if relevant):
    - Any relevant config or flags

    Todos

    - Fix the bug
    - Provide testing instructions in Drupal AI DDEV environment

    Requirements / Acceptance Criteria

    - When I follow the testing instructions I can verify the feature works

    URLs (if applicable)

    - Link to the affected page (can be relative)

    Screenshots (if applicable)

    - Provide a screenshot showing the issue

    Feature

    Title

    Short summary of the feature (e.g., "Add dark mode toggle in settings")

    Description

    - What is the feature?
    - What problem does it solve or what value does it add?

    User Story / Use Case

    As a [type of user], I want to [goal] so that [benefit].

    Todos

    - Create concept
    - Implement
    - Provide testing instructions in Drupal AI DDEV environment
    - Provide documentation

    Requirements / Acceptance Criteria

    - When I read the documentation I understand how the feature is supposed to work
    - When I follow the testing instructions I can verify the feature works

    Design / UI Notes

    - Link to mockups, wireframes, or design files if available

    Dependencies or Related Work

    - Mention any backend work, third-party libraries, or affected components

    URLs (if applicable)

    - Link to spec, design, or existing feature area

    Screenshots (if applicable)

    - Add mockups, visual references, or examples

    Task

    Task Requirements

    Title

    Describe the task clearly (e.g., "Provide documentation for new contributors")

    Description

    - What needs to be done and why
    - Not necessarily user-facing

    Checklist / Subtasks

    - Break down into actionable steps if helpful

    Context / Background

    - Link to related tickets, technical docs, Slack threads, etc.

    Todos

    - Describe what needs to be done

    Requirements / Acceptance Criteria

    - Describe what does “finished” looks like

Production build 0.71.5 2024