Skip to content

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

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

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

Conversation

Copy link
Contributor

Copilot AI commented Oct 7, 2025

Problem

Teachers are not comfortable modifying the codebase directly and are unsure what information to include in issues when requesting changes. This creates friction in the development process and can lead to incomplete or unclear change requests.

Solution

Created a comprehensive set of 6 GitHub issue templates that guide teachers through submitting well-structured change requests for common tasks. Each template auto-assigns to @copilot and ensures all necessary information is captured upfront.

Templates Created

1. 🎓 Nova Atividade Extracurricular

For creating new extracurricular activities with all required details (name, description, type, schedule, capacity).

2. ✏️ Modificar Atividade Existente

For modifying existing activities - supports changing name, description, schedule, days, capacity, and type.

3. 🐛 Reportar Problema

For reporting bugs with complete information including area, description, expected behavior, reproduction steps, and severity.

4. 👥 Gerenciar Inscrições de Estudantes

For bulk student registration management - add, remove, or clear student enrollments.

5. 👨‍🏫 Gerenciar Professores

For managing teacher accounts - add, modify, remove teachers or reset passwords with proper security guidance.

6. 💡 Melhorias e Novas Funcionalidades

For requesting new features with clear problem statements, proposed solutions, and acceptance criteria.

Template Structure

Each template follows best practices and includes:

  • Clear problem description - Structured fields guide users to explain what they need
  • Acceptance criteria - Specific, testable conditions that define completion
  • Technical context - Implementation hints, file paths, and architectural guidance for @copilot
  • Required field validation - Ensures complete information before submission
  • Examples and placeholders - Help users provide properly formatted data
  • Bilingual support - Portuguese UI for teachers, English technical terms for the agent

Additional Documentation

  • README.md - Comprehensive 201-line guide with:

    • When to use each template
    • Step-by-step instructions
    • Best practices and tips
    • FAQ section
  • config.yml - Template configuration that:

    • Disables blank issues (forces template usage)
    • Provides links to documentation and community discussions

Impact

Teachers can now:

  • ✅ Submit change requests without understanding the codebase
  • ✅ Use guided forms instead of writing free-form issues
  • ✅ Provide complete information upfront (no back-and-forth needed)
  • ✅ Get automatic assignment to Copilot for immediate processing
  • ✅ Self-service common tasks quickly and confidently

Files Changed

.github/ISSUE_TEMPLATE/
├── 01-new-activity.yml         (125 lines)
├── 02-modify-activity.yml      (161 lines)
├── 03-bug-report.yml           (151 lines)
├── 04-manage-registrations.yml (108 lines)
├── 05-manage-teachers.yml      (130 lines)
├── 06-feature-request.yml      (141 lines)
├── README.md                   (201 lines)
└── config.yml                  (8 lines)

Total: 8 files, 1,025 lines

All templates have been validated for proper YAML syntax and are ready for immediate use.

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.

Co-authored-by: GabbrielLopes <101233353+GabbrielLopes@users.noreply.github.com>
Copilot AI changed the title [WIP] Add issue templates for teacher change requests Add comprehensive issue templates for teachers to simplify change requests Oct 7, 2025
Copilot AI requested a review from GabbrielLopes October 7, 2025 14:02
@GabbrielLopes GabbrielLopes marked this pull request as ready for review October 7, 2025 14:14
@GabbrielLopes GabbrielLopes merged commit c7bfe84 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