Contribuire al Progetto

Grazie per il tuo interesse in questo progetto! Prima di iniziare a contribuire, ti preghiamo di dedicare un po' di tempo a leggere le seguenti linee guida per garantire che il tuo contributo possa essere accettato senza problemi.

Tipi di Contributi Non Accettati

1. Documentazione internazionalizzazione/traduzione
2. Contributi relativi all'infrastruttura core, come HTTP API, ecc.
3. Issue contrassegnate esplicitamente come "No help needed" (incluse le issue nel repository Byaidu/PDFMathTranslate).
4. Altri contributi ritenuti inappropriati dai maintainer.
5. Contribuire alla documentazione, ma modificando la documentazione in lingue diverse dall'inglese.

Si prega di NON inviare PR relativi ai tipi sopra menzionati.

Processo di Contribuzione

1. Forka questo repository e clonalo localmente.
2. Crea un nuovo branch: git checkout -b feature/<feature-name>.
3. Sviluppa e assicurati che il tuo codice soddisfi i requisiti.
4. Esegui il commit del tuo codice:

   git add .
   git commit -m "<semantic commit message>"
   

5. Esegui il push sul tuo repository: git push origin feature/<feature-name>.
6. Crea una PR su GitHub, fornisci una descrizione dettagliata e richiedi una revisione a @awwaawwa.
7. Assicurati che tutti i controlli automatizzati siano superati.

Requisiti di base

1. Flusso di lavoro

• Si prega di effettuare un fork dal branch main e sviluppare sul proprio branch forkato.
• Quando si invia una Pull Request (PR), fornire una descrizione dettagliata delle modifiche apportate.
• Se la PR non supera i controlli automatizzati (indicati da checks failed e una croce rossa), si prega di rivedere i corrispondenti details e modificare l'invio per garantire che la nuova PR superi tutti i controlli.

2. Sviluppo e Test

• Utilizzare il comando pip install -e . per sviluppo e test.

3. Formattazione del codice

• Configura lo strumento pre-commit e abilita black e flake8 per la formattazione del codice.

4. Aggiornamenti delle dipendenze

• Se introduci nuove dipendenze, aggiorna tempestivamente l'elenco delle dipendenze nel file pyproject.toml.

5. Aggiornamenti della documentazione

• Se aggiungi nuove opzioni per la riga di comando, aggiorna di conseguenza l'elenco delle opzioni per la riga di comando in tutte le versioni linguistiche del file README.md.

6. Messaggi di Commit

• Utilizzare Conventional Commits, ad esempio: feat(translator): add openai.

7. Stile di Codifica

• Assicurati che il codice inviato aderisca agli standard di stile di codifica di base.
• Utilizza snake_case o camelCase per la denominazione delle variabili.

8. Formattazione della Documentazione

• Per la formattazione di README.md, si prega di seguire le Linee guida per la scrittura in cinese.
• Assicurarsi che la documentazione in inglese e cinese sia sempre aggiornata; gli aggiornamenti della documentazione in altre lingue sono opzionali.

Aggiungere un motore di traduzione

1. Aggiungi una nuova classe di configurazione del traduttore nel file pdf2zh/config/translate_engine_model.py.
2. Aggiungi un'istanza della nuova classe di configurazione del traduttore all'alias di tipo TRANSLATION_ENGINE_SETTING_TYPE nello stesso file.
3. Aggiungi la nuova classe di implementazione del traduttore nella cartella pdf2zh/translator/translator_impl.

Struttura del progetto

• cartella config: Sistema di configurazione.
• cartella translator: Implementazioni relative al traduttore.
• gui.py: Fornisce l'interfaccia grafica.
• const.py: Alcune costanti.
• main.py: Fornisce lo strumento da riga di comando.
• high_level.py: Interfacce di alto livello basate su BabelDOC.
• http_api.py: Fornisce l'API HTTP (non avviato).

Contattaci

Se hai domande, invia feedback tramite Issue o unisciti al nostro gruppo Telegram. Grazie per il tuo contributo!