Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 99 additions & 1 deletion .github/ISSUE_TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,101 @@
# 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 [email protected] 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](https://docs.letsmagic.cn/en)
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:

- 💬 **Discussioni**: [GitHub Discussions](https://github.com/dtyq/magic/discussions)
- 📖 **Documentazione**: [docs.letsmagic.cn](https://docs.letsmagic.cn/en) | [中文文档](https://docs.letsmagic.cn/zh)
- 🌐 **Sito Web Ufficiale**: [letsmagic.ai](https://www.letsmagic.ai)
- 📧 **Supporto Enterprise**: [email protected]

## Contributi

Accogliamo con favore i contributi! Consulta la nostra [Guida ai Contributi](../../CONTRIBUTING.md) 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.
Expand Down Expand Up @@ -92,4 +190,4 @@ We welcome contributions! Please see our [Contributing Guide](../../CONTRIBUTING

---

Thank you for helping improve Magic! 🔮
Thank you for helping improve Magic! 🔮
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
TRANSLATION_CHECKLIST.md
.buildpath
.settings/
.project
Expand Down
101 changes: 101 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,104 @@
# CONTRIBUIRE 🎉

Stai cercando di contribuire a Magic — fantastico, non vediamo l'ora di vedere cosa farai. In quanto startup con risorse limitate, abbiamo grandi ambizioni per costruire le applicazioni LLM più potenti. Qualsiasi aiuto dalla community conta, davvero.

Dobbiamo essere agili e rilasciare velocemente, ma vogliamo anche assicurare che i contributori come te abbiano un'esperienza il più possibile fluida. Abbiamo preparato questa guida alla contribuzione per questo scopo, per farti familiarizzare con il codice e con il modo in cui lavoriamo con i contributori, così potrai passare rapidamente alla parte divertente.

Questa guida, come Magic stesso, è un lavoro in corso. Apprezziamo molto la tua comprensione se a volte è in ritardo rispetto al progetto reale, e accogliamo con favore qualsiasi feedback per migliorare.

Per quanto riguarda la licenza, dedica un minuto a leggere la nostra breve [License and Contributor Agreement](./LICENSE). La community aderisce anche al [code of conduct](https://github.com/dtyq/.github/blob/main/CODE_OF_CONDUCT.md). 📜

## Prima di iniziare 🔎

Cerchi qualcosa da affrontare? Sfoglia le nostre [good first issues](https://github.com/dtyq/magic/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) e scegli una per iniziare!

Hai una bella idea o una funzionalità da aggiungere? Apri una PR nel nostro [repository principale](https://github.com/dtyq/magic) e mostraci cosa hai costruito.

Devi aggiornare una funzionalità esistente o risolvere dei bug? Apri una PR nel nostro [repository principale](https://github.com/dtyq/magic) e fai accadere la tua magia! ✨

Unisciti al divertimento, contribuisci e costruiamo qualcosa di straordinario insieme! 💡

Non dimenticare di collegare un issue esistente o aprirne uno nuovo nella descrizione della PR.

### Segnalazione bug 🐛

> [! IMPORTANT]
> Assicurati di includere le seguenti informazioni quando invii una segnalazione di bug:

- Un titolo chiaro e descrittivo
- Una descrizione dettagliata del bug, inclusi eventuali messaggi di errore
- Passi per riprodurre il bug
- Comportamento atteso
- **Log**, se disponibili; per problemi backend sono molto importanti, puoi trovarli nei docker-compose logs
- Screenshot o video, se applicabili 📷

Come priorizziamo:

| Tipo di Issue | Priorità |
| --------------------------------------------------------------------------------------------- | --------------- |
| Bug in funzioni core (servizio cloud, impossibile fare il login, applicazioni non funzionanti, falle di sicurezza) | Critica |
| Bug non critici, miglioramenti di performance | Priorità Media |
| Correzioni minori (refusi, UI confusa ma funzionante) | Bassa Priorità |

### Richieste di funzionalità ✨

> [! NOTE]
> Assicurati di includere le seguenti informazioni quando invii una richiesta di funzionalità:

- Un titolo chiaro e descrittivo
- Una descrizione dettagliata della funzionalità
- Un caso d'uso per la funzionalità
- Qualsiasi altro contesto o screenshot relativo alla richiesta

Come priorizziamo:

| Tipo di Funzionalità | Priorità |
| --------------------------------------------------------------------------------------------- | --------------- |
| Funzionalità ad alta priorità etichettate da un membro del team | Alta Priorità |
| Richieste popolari dalla nostra [community feedback board](https://github.com/dtyq/magic/discussions/categories/feedbacks) | Priorità Media |
| Funzionalità non core e miglioramenti minori | Bassa Priorità |
| Valide ma non immediate | Futuro |

## Inviare la tua PR 🔧

### Processo di Pull Request

1. Fork del repository
2. Prima di creare una PR, crea un issue per discutere le modifiche che vuoi fare
3. Crea un nuovo branch per le tue modifiche
4. Aggiungi i test per le tue modifiche dove appropriato 🧪
5. Assicurati che il tuo codice passi i test esistenti ✅
6. Collega l'issue nella descrizione della PR, `fixes #<issue_number>`
7. Vieni mergiato! 🚀

### Configurare il progetto

#### Frontend

Per impostare il servizio frontend, fai riferimento alla nostra guida completa nel file `frontend/README.md`: https://github.com/dtyq/magic/blob/main/frontend/README.md. Questo documento fornisce istruzioni dettagliate per configurare correttamente l'ambiente frontend.

#### Backend

Per impostare il servizio backend, fai riferimento alle istruzioni nel file `backend/README.md`: https://github.com/dtyq/magic/blob/main/backend/README.md. Questo documento contiene indicazioni passo passo per avviare il backend senza problemi.

#### Altre note importanti

Ti consigliamo di leggere attentamente questo documento prima di procedere con la configurazione, poiché contiene informazioni essenziali su:
- Prerequisiti e dipendenze
- Passaggi di installazione
- Dettagli di configurazione
- Suggerimenti comuni per il troubleshooting

Sentiti libero di contattarci se incontri problemi durante la configurazione.

## Ottenere aiuto ❓

Se rimani bloccato o hai una domanda urgente mentre contribuisci, invia le tue richieste tramite l'issue GitHub correlato.

---

Testo originale (inglese) — non cancellare, spostato sotto:

# CONTRIBUTING

So you're looking to contribute to Magic - that's awesome, we can't wait to see what you do. As a startup with limited headcount and funding, we have grand ambitions to build most powerful LLM applications. Any help from the community counts, truly.
Expand Down
99 changes: 99 additions & 0 deletions CONTRIBUTING_CN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,102 @@
# Guida ai Contributi 🎉

Siamo felici che tu sia interessato a contribuire a Magic - è fantastico, non vediamo l'ora di vedere cosa farai. Come startup con risorse limitate in termini di personale e finanziamenti, abbiamo grandi ambizioni di costruire le applicazioni LLM più potenti. Qualsiasi aiuto dalla community conta davvero.

Considerando la nostra situazione attuale, dobbiamo essere agili e rilasciare velocemente, ma vogliamo anche assicurarci che contributori come te abbiano un'esperienza di contribuzione il più fluida possibile. Per questo abbiamo scritto questa guida ai contributi, con l'obiettivo di familiarizzarti con il codebase e con il modo in cui lavoriamo con i contributori, così potrai passare rapidamente alla parte divertente.

Questa guida, come Magic stesso, è un lavoro in corso. Apprezziamo molto la tua comprensione se a volte è in ritardo rispetto al progetto reale, e accogliamo con favore qualsiasi feedback per migliorare.

Per quanto riguarda la licenza, dedica un minuto a leggere il nostro breve [Accordo di Licenza e Contributore](./LICENSE). La community aderisce anche al [codice di condotta](https://github.com/dtyq/.github/blob/main/CODE_OF_CONDUCT.md).

## Prima di Iniziare 🔎

Cerchi qualcosa da affrontare? Sfoglia i nostri [problemi adatti ai principianti](https://github.com/dtyq/magic/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) e scegline uno per iniziare!

Hai una bella idea o una funzionalità da aggiungere? Apri una PR nel nostro [repository principale](https://github.com/dtyq/magic) e mostraci cosa hai costruito.

Devi aggiornare una funzionalità esistente o risolvere dei bug? Apri una PR nel nostro [repository principale](https://github.com/dtyq/magic) e fai accadere la tua magia! ✨

Unisciti al divertimento, contribuisci e costruiamo qualcosa di straordinario insieme! 💡

Non dimenticare di collegare un issue esistente o aprirne uno nuovo nella descrizione della PR.

### Segnalazione Bug 🐛

> [!IMPORTANTE]
> Assicurati di includere le seguenti informazioni quando invii una segnalazione di bug:

- Un titolo chiaro e descrittivo
- Una descrizione dettagliata del bug, inclusi eventuali messaggi di errore
- Passi per riprodurre il bug
- Comportamento atteso
- **Log**, se disponibili; per problemi backend sono molto importanti, puoi trovarli nei log di docker-compose
- Screenshot o video, se applicabili 📷

Come determiniamo le priorità:

| Tipo di Problema | Priorità |
| ---------------- | --------- |
| Bug in funzioni core (servizio cloud, impossibile fare il login, applicazioni non funzionanti, falle di sicurezza) | Critica |
| Bug non critici, miglioramenti di performance | Priorità Media |
| Correzioni minori (refusi, UI confusa ma funzionante) | Bassa Priorità |

### Richieste di Funzionalità ✨

> [!NOTA]
> Assicurati di includere le seguenti informazioni quando invii una richiesta di funzionalità:

- Un titolo chiaro e descrittivo
- Una descrizione dettagliata della funzionalità
- Un caso d'uso per la funzionalità
- Qualsiasi altro contesto o screenshot relativo alla richiesta di funzionalità

Come determiniamo le priorità:

| Tipo di Funzionalità | Priorità |
| -------------------- | --------- |
| Funzionalità contrassegnate come ad alta priorità dai membri del team | Alta Priorità |
| Richieste di funzionalità popolari dal nostro [forum di feedback della community](https://github.com/dtyq/magic/discussions/categories/feedbacks) | Priorità Media |
| Funzionalità non core e piccoli miglioramenti | Bassa Priorità |
| Funzionalità preziose ma non urgenti | Funzionalità Future |

## Invia la tua PR 🚀

### Processo Pull Request

1. Fai il fork del repository
2. Prima di redigere la PR, crea un issue per discutere le modifiche che vuoi fare
3. Crea un nuovo branch per le tue modifiche
4. Aggiungi test appropriati per le tue modifiche
5. Assicurati che il tuo codice passi i test esistenti
6. Collega l'issue relativo nella descrizione della PR, `fixes #<issue_number>`
7. Merge riuscito!

### Configurazione Progetto

#### Frontend

Per configurare il servizio frontend, fai riferimento alla guida completa nel file `frontend/README.md`: https://github.com/dtyq/magic/blob/main/frontend/README.md. Questo documento fornisce istruzioni dettagliate per configurare correttamente l'ambiente frontend.

#### Backend

Per configurare il servizio backend, fai riferimento alle istruzioni nel file `backend/README.md`: https://github.com/dtyq/magic/blob/main/backend/README.md. Questo documento contiene indicazioni passo passo per avviare il backend senza problemi.

#### Altre Note

Ti consigliamo di leggere attentamente questo documento prima di procedere con la configurazione, poiché contiene informazioni importanti su:
- Prerequisiti e dipendenze
- Passi di installazione
- Dettagli di configurazione
- Suggerimenti comuni per la risoluzione dei problemi

Se incontri qualsiasi problema durante la configurazione, non esitare a contattarci.

## Ottieni Aiuto 🆘

Se incontri difficoltà durante il processo di contribuzione o hai problemi urgenti, sentiti libero di farci domande attraverso l'issue GitHub correlato.

---

# 贡献指南

很高兴你有兴趣为 Magic 做出贡献 - 这太棒了,我们迫不及待地想看看你会做些什么。作为一家人员和资金有限的创业公司,我们有宏大的抱负,致力于构建最强大的 LLM 应用程序。来自社区的任何帮助都非常重要,这是真的。
Expand Down
Loading