Skip to content

Add comprehensive issue templates to simplify change requests for teachers#12

Merged
jaisonschmidt merged 3 commits intomainfrom
copilot/create-issue-templates-for-teachers
Oct 7, 2025
Merged

Add comprehensive issue templates to simplify change requests for teachers#12
jaisonschmidt merged 3 commits intomainfrom
copilot/create-issue-templates-for-teachers

Conversation

Copy link
Contributor

Copilot AI commented Oct 7, 2025

Problem

Teachers at Mergington High School are not comfortable modifying code directly and are uncertain about what information to include in issues when requesting changes to the school management system. This creates friction in the development process and leads to incomplete or unclear requirements.

Solution

This PR introduces 8 comprehensive, form-based issue templates that guide teachers through structured data entry without requiring any coding knowledge. Each template includes:

  • Guided forms with clear field labels and validation
  • Dropdown menus for consistent data entry
  • Examples and placeholders for each field
  • Acceptance criteria checklists for verification
  • Technical implementation notes for Copilot agents
  • Relevant file references and architecture guidance

Templates Created

Activity Management

  • 🎓 Add New Activity - Create extracurricular activities with schedule, capacity, and type
  • ✏️ Modify Activity - Update schedules, descriptions, capacity, or responsible teachers
  • 🗑️ Remove Activity - Deactivate or permanently remove activities

User Management

  • 👨‍🏫 Manage Teacher Account - Add, modify, or remove teacher accounts with proper roles

System Quality

  • 🐛 Bug Report - Report issues with reproduction steps, severity, and affected areas
  • Feature Request - Suggest new functionality with clear requirements and use cases
  • 🎨 UI/UX Improvement - Propose interface enhancements with visual examples
  • 📚 Documentation - Request documentation improvements or additions

Key Features

User-Friendly Design

All templates are written in Portuguese (matching the system language) and use:

  • Required fields marked with asterisks (*)
  • Clear, domain-specific terminology (activities, teachers, students)
  • Practical examples relevant to school operations
  • No technical jargon unless necessary

Copilot Integration

Each template includes:

  • copilot-assignable label for automated processing
  • Implementation hints and best practices
  • References to domain entities (Activity, Teacher, ActivityType, ScheduleDetails)
  • File paths for relevant code (domain/, application/, infrastructure/)
  • Testing commands (mvn test, mvn clean install)
  • Security considerations (Argon2 passwords, validation patterns)

Clean Architecture Alignment

Templates reference the existing codebase structure:

  • Domain layer entities and value objects
  • Application layer use cases and DTOs
  • Infrastructure layer migrations and repositories
  • Presentation layer controllers and mappers

Documentation

  • ISSUE_TEMPLATE_GUIDE.md: Comprehensive 8KB guide explaining how to use each template, with examples and best practices
  • docs/README.md: Updated with a new section highlighting the issue templates and linking to the guide

Usage

Teachers can now:

  1. Navigate to Issues → New Issue
  2. Select the appropriate template from the chooser
  3. Fill out the guided form
  4. Submit and optionally assign @copilot for automated processing

Example: Add Activity Template

When creating a new activity, teachers provide:

  • Activity name and description
  • Type (Sports, Arts, Music, Academic, Technology, Community, Other)
  • Maximum capacity
  • Days of the week (checkboxes)
  • Start and end times
  • Responsible teacher username
  • Additional information

The template then generates a structured issue with all information needed for implementation, including technical notes about using Mongock migrations, ScheduleDetails value objects, and ActivityType enums.

Benefits

For Teachers:

  • No programming knowledge required
  • Clear, guided process for all requests
  • Reduced errors through field validation
  • Faster submission process

For Development:

  • Consistent, structured data
  • Complete requirements captured upfront
  • Enables automated processing by Copilot
  • Reduces clarification requests

Testing

  • ✅ All YAML files validated for correct syntax
  • ✅ Build system verified with mvn clean test
  • ✅ No changes to application code (template-only implementation)
  • ✅ Documentation comprehensive and cross-referenced

Closes #[issue-number]

Original prompt

This section details on the original issue you should resolve

<issue_title>Simplifique solicitações de mudança para professores</issue_title>
<issue_description>Os professores não se sentem confortáveis em modificar o programa diretamente. Eles também não têm certeza do que colocar nas issues para explicar o que precisam.

Recomendação

Crie uma série de formulários de template de issue para tarefas comuns. Certifique-se de que detalhes suficientes sejam exigidos para que o agente de codificação Copilot possa ser facilmente designado para essas tarefas sem explicações adicionais.

Contexto

Uma issue bem definida normalmente inclui estes itens (no mínimo):

  • Descrição clara do problema
  • Critérios de aceitação claros
  • Dicas, sugestões e soluções para começar
  • Limitações, informações relacionadas e outros contextos</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #5

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits October 7, 2025 13:53
Co-authored-by: jaisonschmidt <31486070+jaisonschmidt@users.noreply.github.com>
Co-authored-by: jaisonschmidt <31486070+jaisonschmidt@users.noreply.github.com>
Copilot AI changed the title [WIP] Add issue templates for teacher change requests Add comprehensive issue templates to simplify change requests for teachers Oct 7, 2025
Copilot AI requested a review from jaisonschmidt October 7, 2025 13:58
@jaisonschmidt jaisonschmidt marked this pull request as ready for review October 7, 2025 14:11
@jaisonschmidt jaisonschmidt merged commit c4ee4a9 into main Oct 7, 2025
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.

Simplifique solicitações de mudança para professores

2 participants