Skip to content

Latest commit

 

History

History
193 lines (133 loc) · 6.93 KB

File metadata and controls

193 lines (133 loc) · 6.93 KB

Template Issue di Magic

Questa directory contiene template per le issue del progetto Magic per aiutarti a segnalare problemi e richiedere funzionalità in modo efficace.

🇮🇹 Utenti Italiani: Utilizza i template qui sotto senza il suffisso -zh.

Template Disponibili

🐛 Segnalazione Bug (01-bug-report.yml)

Utilizza questo template per segnalare bug o comportamenti inattesi in Magic.

Quando utilizzare:

  • Magic non funziona come previsto
  • Incontri errori o crash
  • Le funzionalità si comportano in modo incorretto

✨ Richiesta Funzionalità (02-feature-request.yml)

Utilizza questo template per suggerire nuove funzionalità o miglioramenti.

Quando utilizzare:

  • Hai un'idea per migliorare Magic
  • Hai bisogno di funzionalità che non esistono
  • Vuoi suggerire miglioramenti alle funzionalità esistenti

📚 Documentazione (03-documentation.yml)

Utilizza questo template per segnalare problemi di documentazione o suggerire miglioramenti.

Quando utilizzare:

  • La documentazione è mancante, poco chiara o incorretta
  • Hai bisogno di esempi o tutorial migliori
  • La documentazione API necessita aggiornamenti

⚡ Problema di Performance (04-performance.yml)

Utilizza questo template per segnalare problemi di performance o suggerire ottimizzazioni.

Quando utilizzare:

  • Magic funziona lentamente
  • Uso elevato delle risorse (CPU, memoria)
  • Gli endpoint API impiegano troppo tempo a rispondere

🔒 Problema di Sicurezza (05-security.yml)

Utilizza questo template per segnalare problemi di sicurezza non critici.

⚠️ IMPORTANTE: Per vulnerabilità di sicurezza critiche, invia un'email direttamente a team@dtyq.com invece di creare un issue pubblico.

Quando utilizzare:

  • Header di sicurezza mancanti
  • Dipendenze obsolete
  • Miglioramenti delle best practice di sicurezza

🔌 Problema API / Integrazione (06-api-integration.yml)

Utilizza questo template per segnalare problemi con API, SDK o integrazioni di terze parti.

Quando utilizzare:

  • Gli endpoint API non funzionano correttamente
  • L'integrazione con servizi esterni fallisce
  • Problemi con SDK o librerie

🚀 Problema di Deployment / Installazione (07-deployment.yml)

Utilizza questo template per segnalare problemi con l'installazione o il deployment di Magic.

Quando utilizzare:

  • Il processo di installazione fallisce
  • I container Docker non si avviano
  • Problemi di configurazione durante l'installazione

Come Scegliere il Template Giusto

  1. Inizia con il tipo di issue - Che tipo di problema stai riscontrando?
  2. Considera il componente - Quale parte di Magic è interessata?
  3. Verifica la gravità - Quanto è critico il problema?

Prima di Creare un'Issue

  1. Cerca issue esistenti - Verifica se il tuo problema è già stato segnalato
  2. Leggi la documentazione - Visita docs.letsmagic.cn
  3. Prova l'ultima versione - Assicurati di utilizzare la release più recente
  4. Raccogli informazioni - Raccogli log, messaggi di errore e dettagli dell'ambiente

Hai Bisogno di Aiuto?

Se non sei sicuro di quale template utilizzare o hai bisogno di aiuto con Magic:

Contributi

Accogliamo con favore i contributi! Consulta la nostra Guida ai Contributi per ulteriori informazioni su come contribuire a Magic.


Grazie per aiutare a migliorare Magic! 🔮


Magic Issue Templates

This directory contains issue templates for the Magic project to help you report issues and request features effectively.

🇺🇸 English Users: Use the templates below without the -zh suffix.

Available Templates

🐛 Bug Report (01-bug-report.yml)

Use this template to report bugs or unexpected behavior in Magic.

When to use:

  • Magic is not working as expected
  • You encounter errors or crashes
  • Features are behaving incorrectly

✨ Feature Request (02-feature-request.yml)

Use this template to suggest new features or enhancements.

When to use:

  • You have an idea for improving Magic
  • You need functionality that doesn't exist
  • You want to suggest enhancements to existing features

📚 Documentation (03-documentation.yml)

Use this template to report documentation issues or suggest improvements.

When to use:

  • Documentation is missing, unclear, or incorrect
  • You need better examples or tutorials
  • API documentation needs updates

⚡ Performance Issue (04-performance.yml)

Use this template to report performance problems or suggest optimizations.

When to use:

  • Magic is running slowly
  • High resource usage (CPU, memory)
  • API endpoints are taking too long to respond

🔒 Security Issue (05-security.yml)

Use this template to report non-critical security issues.

⚠️ IMPORTANT: For critical security vulnerabilities, email team@dtyq.com directly instead of creating a public issue.

When to use:

  • Missing security headers
  • Outdated dependencies
  • Security best practice improvements

🔌 API / Integration Issue (06-api-integration.yml)

Use this template to report issues with APIs, SDKs, or third-party integrations.

When to use:

  • API endpoints are not working correctly
  • Integration with external services is failing
  • SDK or library issues

🚀 Deployment / Installation Issue (07-deployment.yml)

Use this template to report problems with installing or deploying Magic.

When to use:

  • Installation process is failing
  • Docker containers won't start
  • Configuration issues during setup

How to Choose the Right Template

  1. Start with the issue type - What kind of problem are you experiencing?
  2. Consider the component - Which part of Magic is affected?
  3. Check severity - How critical is the issue?

Before Creating an Issue

  1. Search existing issues - Check if your issue has already been reported
  2. Read the documentation - Visit docs.letsmagic.cn
  3. Try the latest version - Ensure you're using the most recent release
  4. Gather information - Collect logs, error messages, and environment details

Need Help?

If you're unsure which template to use or need help with Magic:

Contributing

We welcome contributions! Please see our Contributing Guide for more information on how to contribute to Magic.


Thank you for helping improve Magic! 🔮