An open API service indexing awesome lists of open source software.

https://github.com/marcelod/symfony-docs-pt-br

Portuguese translation of the Symfony2 Documentation (official repository)
https://github.com/marcelod/symfony-docs-pt-br

Last synced: 8 months ago
JSON representation

Portuguese translation of the Symfony2 Documentation (official repository)

Awesome Lists containing this project

README

          

Contribuindo com a tradução da documentação oficial do Symfony2:
================================================================

Informando os documentos que deseja traduzir
--------------------------------------------

Para melhor organização, primeiro informe o(s) documento(s) que pretende ajudar na tradução e/ou revisão na planilha de tradutores/revisores:
https://spreadsheets.google.com/ccc?key=0AtX-XMIXR2DAdFBMekh4UktObUNOMy1NX2RSMjJMUUE

Se ainda não possuir acesso de edição nesta planilha, solicitar o acesso para andreiabohner at gmail dot com.

Utilizando o Git e o Github
---------------------------

1. Para começar, faça o fork do repositório master da tradução para o português no github:

1.1 Acessar o repositório master no github: https://github.com/andreia/symfony-docs-pt-BR
1.2 Clicar no botão fork

2. Agora, você irá "clonar" o projeto para a sua máquina local:

2.1 Copiar a URL do repositório do seu fork, para utilizá-la com o comando git clone (por exemplo)::

$ git clone git@github.com:seuusername/symfony-docs.git

2.2 Após completar o clone do repositório, ele terá o nome remoto "origin". Não confundir, apesar do nome ser origin ele não está apontando para o repo master, mas sim para o seu fork no github.

3. Copie o(s) documento(s) que você irá traduzir (verifique se os mesmos já não foram traduzidos em https://github.com/andreia/symfony-docs-pt-BR) do repositório oficial em inglês ( https://github.com/symfony/symfony-docs ).
Pronto, agora é só trabalhar na tradução do(s) documento(s).

4. Copie o(s) documento(s) que você traduziu para os respectivos diretórios em seu repositório local (o que você criou no passo 2).

5. Finalizadas as traduções e/ou revisões, adicione os novos documentos (se for uma nova tradução) e faça o commit das alterações no seu repositório local::

$ git add
$ git commit –a –m "pt_BR translation"

6. Atualize o seu repositório no servidor github com as alterações realizadas localmente::

$ git push origin master

7. O último passo é informar sobre as suas alterações ao responsável pelo repositório de origem, para realizar um pull das alterações no repositório. Para isso, acesse a página do repositório original no github, em: https://github.com/andreia/symfony-docs-pt-BR e envie um pull request (clicando no botão "Pull Request"):
Mais informações sobre o `Pull Request`_

Mantendo seu repositório local atualizado
-----------------------------------------

Sempre antes de fazer as suas alterações locais, lembrar de executar o comando ``pull`` para manter atualizado o seu repositório local trazendo as alterações do repositório de origem (o repositório que você fez o fork)::

$ git remote add upstream git@github.com:andreia/symfony-docs-pt-BR.git
$ git pull upstream master

Padrões a serem seguidos durante a tradução
-------------------------------------------

Mensagens dos Commits
~~~~~~~~~~~~~~~~~~~~~

As mensagens dos commits devem ser todas em INGLÊS e devem ter o seguinte prefixo:
[pt_BR][Livro][Capítulo] seguido da mensagem do commit.
Ex.: Se você estiver traduzindo o capítulo 'Validation' do livro, a mensagem do commit poderia ser semelhante a seguinte:
[pt_BR][Book][Validation] Fix typo.

Dica: Escrevendo boas mensagens de commit: https://github.com/erlang/otp/wiki/Writing-good-commit-messages

Código
~~~~~~

Os códigos serão mantidos todos em inglês.

Formato da documentação
~~~~~~~~~~~~~~~~~~~~~~~

A documentação do Symfony2 utiliza a linguagem markup reStructuredText juntamente com o Sphinx. Segue a referência: http://symfony.com/doc/2.0/contributing/documentation/format.html
Se preferir, existe um editor online, que pode auxiliar em: http://rst.ninjs.org/

.. _`Pull Request`: http://help.github.com/pull-requests/

Glossário
~~~~~~~~~

Para mantermos consistente a tradução dos documentos, verifique no glossário os termos que não devem ser traduzidos e aqueles que devem seguir a mesma tradução:
http://andreia.github.com/symfony-docs-pt-BR/

Visualização dos documentos traduzidos
--------------------------------------

Para facilitar a revisão dos documentos, sempre que uma nova tradução é adicionada/modificada aqui no repositório ela é renderizada no seguinte endereço:
http://andreiabohner.org/symfony2docs/index.html

Referências
-----------

- SSH issues: Guia contendo as soluções para os problemas mais comuns referentes a conexão SSH no GitHub (chave pública, ...): http://help.github.com/ssh-issues/
- Mencionar alguém em um ``pull request`` ou ``issue``: https://github.com/blog/1004-mention-autocompletion