Skip to content
alfsb edited this page Jan 12, 2023 · 19 revisions

Por onde começar

Olá, e seja bem vindo!

Caso tenha encontrado algum problema na tradução, ou um arquivo desatualizado, você pode realizar alterações diretamente do seu navegador através de um fork e pull requests deste projeto (mais detalhes abaixo).

Para participar mais ativamente, da mesma forma que os tradutores oficiais, há o longo e detalhado Guia de edição do manual do PHP.

As discussões ocorrem via issues aqui ou através da lista de discussão oficial.

Os arquivos desatualizados são prioridade, e podem ser conferidos na Situação atual. Ao traduzir um arquivo, é importante também atualizar a Tag de revisão.

Roteiros de tradução

Há várias maneiras de contribuir com o manual, a saber.

  • O procedimento comum de fork e pull request do GitHub. Ver Roteiro GitHub se precisar de detalhes;

  • Um procedimento semelhante, mas em linha de comando, mais parecido com o ferramental oficial da tradução, que permite realizar a compilação local do manual, detectar erros e gerar estatísticas. Ver o Roteiro Git.

  • O procedimento oficial, direto, utilizado por editores e tradutores do manual, e detalhado no Guia de edição do manual do PHP.

Estas opções estão listadas em ordem de facilidade de começar. A primeira opção permite realizar traduções direto do navegador mas não fornecem ferramental de verificação. As últimas opções, que utilizam linha de comando, exigem maior conhecimento e instalação de ambiente, sendo mais facilmente montado e mantido em ambientes Linux. Apesar da complicação a mais, é o necessário para trabalhar ma tradução com maior frequência.

As primeiras opções permitem participar da tradução sem acesso à organização do PHP. O procedimento para conseguir o acesso, aliás, é começar a traduzir sem uma credencial, enviando patchs ou pull requests através deste projeto. As credenciais podem ser solicitadas depois de alguns meses de envios contínuos.

Super resumido

Pequenas correções e ajustes usando GitHub:

  1. Faça um fork do projeto php/doc-pt_br;
  2. Altere o arquivo no seu fork, diretamente pelo navegador mesmo;
  3. Faça um pull request dessas alterações.

Ou para trabalhar com arquivos locais:

  1. Faça um fork do projeto php/doc-pt_br;
  2. Clone o fork na sua máquina;
  3. Configure o remote upstream;
  4. Sincronize o upstream antes de começar um alteração;
  5. Faça alterações no seu fork. Tag de revisão é importante. Commit e push.
  6. Faça um pull request dessas alterações.

Ou ainda a versão script:

Setup inicial:

# Seu nome de usuário aqui:
GU="seu_user_github_aqui"

mkdir phpdoc
cd phpdoc
git clone git@github.com:php/doc-base.git   doc-base
git clone git@github.com:php/doc-en.git     en
git clone git@github.com:$GU/doc-pt_br.git  pt_BR

cd pt_BR
git remote add upstream git@github.com:php/doc-pt_br.git
cd ..

Toda ver que iniciar ou terminar uma tradução:

(cd pt_BR;    git fetch upstream)

(cd doc-base; git pull)
(cd en;       git pull)
(cd pt_BR;    git pull)

php doc-base/scripts/revcheck.php pt_BR > revcheck.html
xdg-open revcheck.html

php doc-base/configure.php --with-lang=pt_BR --enable-xml-details

(cd pt_BR; git status)

Em vídeo!

TODO

Clone this wiki locally