Contribuindo para o projeto

Caution

Os mantenedores atuais do projeto estão pesquisando a internacionalização automatizada de documentação. Portanto, qualquer PR relacionado à internacionalização/tradução de documentação NÃO será aceito!

Por favor, NÃO envie PRs relacionados à internacionalização/tradução de documentação!

Obrigado pelo seu interesse neste projeto! Antes de começar a contribuir, reserve um tempo para ler as seguintes diretrizes para garantir que sua contribuição possa ser aceita sem problemas.

Tipos de Contribuições Não Aceitas

Internacionalização/tradução da documentação
Contribuições relacionadas à infraestrutura principal, como API HTTP, etc.
Problemas explicitamente marcados como "No help needed" (incluindo problemas nos repositórios Byaidu/PDFMathTranslate e PDFMathTranslate-next/PDFMathTranslate-next).
Outras contribuições consideradas inadequadas pelos mantenedores.
Contribuição com documentação, mas alterando a documentação em idiomas diferentes do inglês.
PRs que exigem modificação de arquivos PDF.
PRs que modificam o arquivo pdf2zh_next/gui_translation.yaml.

Por favor, NÃO envie PRs relacionados aos tipos mencionados acima.

Note

Se você deseja contribuir com a documentação, por favor modifique apenas a versão em inglês da documentação. As outras versões em outros idiomas são traduzidas pelos próprios contribuidores.

OUTPUT

PRs que são recomendados discutir com os mantenedores via Issue antes da submissão

OUTPUT

PRs relacionados à funcionalidade de compartilhamento multiutilizador. (Este projeto é principalmente projetado para uso de utilizador único e não pretende introduzir um sistema multiutilizador abrangente).
PRs relacionados à implementação de um sistema de plugins.
PRs relacionados à implementação de um mercado para plugins.
PRs relacionados à implementação de um sistema de utilizador.
PRs relacionados à implementação de um sistema de pagamento.
PRs relacionados à implementação de um sistema de subscrição.
PRs relacionados à implementação de um sistema de autenticação de utilizador.
PRs relacionados à implementação de um sistema de autorização de utilizador.
PRs relacionados à implementação de um sistema de gestão de utilizadores.
PRs relacionados à implementação de um sistema de perfil de utilizador.
PRs relacionados à implementação de um sistema de definições de utilizador.
PRs relacionados à implementação de um sistema de notificação de utilizador.
PRs relacionados à implementação de um sistema de rastreamento de atividade do utilizador.
PRs relacionados à implementação de um sistema de análise de utilizador.
PRs relacionados à implementação de um sistema de feedback do utilizador. 16.极不推荐添加新的依赖，除非是必要的

Processo de Contribuição

Faça um fork deste repositório e clone-o localmente.
Crie uma nova branch: git checkout -b feature/<feature-name>.
Desenvolva e certifique-se de que seu código atenda aos requisitos.

Faça commit do seu código:

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

Envie para o seu repositório: git push origin feature/<feature-name>.
Crie um PR no GitHub, forneça uma descrição detalhada e solicite uma revisão de @awwaawwa.
Certifique-se de que todas as verificações automatizadas sejam aprovadas.

Tip

Você não precisa esperar até que seu desenvolvimento esteja totalmente completo para criar um PR. Criar um PR antecipadamente nos permite revisar sua implementação e fornecer sugestões.

Se você tiver alguma dúvida sobre o código-fonte ou assuntos relacionados, entre em contato com o mantenedor em [email protected].

Os arquivos de recursos para a versão 2.0 são compartilhados com BabelDOC. O código para baixar os recursos relacionados está no BabelDOC. Se você deseja adicionar novos arquivos de recursos, entre em contato com o mantenedor do BabelDOC em [email protected].

Requisitos básicos

1. Fluxo de trabalho

Por favor, faça um fork a partir do branch main e desenvolva no seu branch bifurcado.
Ao enviar um Pull Request (PR), forneça uma descrição detalhada das suas alterações.
Se o seu PR não passar nas verificações automatizadas (indicado por checks failed e um cruz vermelho), revise os details correspondentes e modifique sua submissão para garantir que o novo PR passe em todas as verificações.

2. Desenvolvimento e Teste

Use o comando pip install -e . para desenvolvimento e teste.

3. Formatação de Código

Configure a ferramenta pre-commit e ative black e flake8 para formatação de código.

4. Atualizações de Dependências

Se você introduzir novas dependências, atualize a lista de dependências no arquivo pyproject.toml em tempo hábil.

5. Atualizações da Documentação

Se você adicionar novas opções de linha de comando, atualize a lista de opções de linha de comando em todas as versões de idioma do arquivo README.md de acordo.

6. Mensagens de Commit

Use Conventional Commits, por exemplo: feat(translator): add openai.

7. Estilo de Codificação

Certifique-se de que o código enviado adere aos padrões básicos de estilo de codificação.
Use snake_case ou camelCase para nomeação de variáveis.

8. Formatação de Documentação

Para a formatação de README.md, siga as Diretrizes de Redação em Chinês.
Certifique-se de que a documentação em inglês e chinês esteja sempre atualizada; as atualizações de documentação em outros idiomas são opcionais.

Adicionando um mecanismo de tradução

Adicione uma nova classe de configuração de tradutor no arquivo pdf2zh/config/translate_engine_model.py.
Adicione uma instância da nova classe de configuração de tradutor ao alias de tipo TRANSLATION_ENGINE_SETTING_TYPE no mesmo arquivo.
Adicione a nova classe de implementação de tradutor na pasta pdf2zh/translator/translator_impl.

Note

Este projeto não pretende suportar nenhum mecanismo de tradução com um RPS (solicitações por segundo) inferior a 4. Por favor, não envie suporte para tais mecanismos. Os seguintes tipos de tradutores também não serão integrados: - Tradutores que foram descontinuados pelos mantenedores upstream (como deeplx) - Tradutores com grandes dependências (como aqueles que dependem de pytorch) - Tradutores instáveis - Tradutor Baseado em API de Engenharia Reversa

Quando você não tem certeza se um tradutor atende aos requisitos, pode enviar um problema para discutir com os mantenedores.

Estrutura do Projeto

config folder: Sistema de configuração.
translator folder: Implementações relacionadas ao tradutor.
gui.py: Fornece a interface GUI.
const.py: Algumas constantes.
main.py: Fornece a ferramenta de linha de comando.
high_level.py: Interfaces de alto nível baseadas no BabelDOC.
http_api.py: Fornece API HTTP (não iniciada).

Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki Ask AI to understand the project: DeepWiki

Entre em contato conosco

Se você tiver alguma dúvida, envie feedback via Issue ou entre em nosso Grupo no Telegram. Obrigado pela sua contribuição!

Tip

Immersive Translate patrocina códigos de assinatura Pro mensais para contribuidores ativos deste projeto. Para mais detalhes, consulte: Regras de Recompensa para Contribuidores do BabelDOC/PDFMathTranslate

Contribuindo para o projeto

Tipos de Contribuições Não Aceitas

OUTPUT

PRs que são recomendados discutir com os mantenedores via Issue antes da submissão

OUTPUT

Processo de Contribuição

Requisitos básicos

1. Fluxo de trabalho

2. Desenvolvimento e Teste

3. Formatação de Código

4. Atualizações de Dependências

5. Atualizações da Documentação

6. Mensagens de Commit

7. Estilo de Codificação

8. Formatação de Documentação

Adicionando um mecanismo de tradução

Estrutura do Projeto

Entre em contato conosco

Parte do conteúdo desta página foi traduzida pelo GPT e pode conter erros.