Saiba como contribuir com o projeto CEREBRO e fortalecer ainda mais a nossa comunidade.
As traduções se aplicam somente aos artigos.
Para editores
- Abra uma issue, informando o título e o link para o artigo original.
- Adicione a label tradução na issue recém-criada e inicie a tradução do artigo.
- Faça o Pull Request do arquivo traduzido.
- Adicione um comentário na issue convocando os editores (@cerebrobr/editores).
- Modifique a label desta issue para revisão.
Para colaboradores
- Faça o fork do repositório artigos.
- Abra uma issue, informando o título e o link para o artigo original.
- Solicite a inclusão da label tradução na issue recém-criada.
- Realize a tradução do artigo.
- Faça o Pull Request para enviar o artigo traduzido.
- Adicione um comentário na issue convocando os editores (@cerebrobr/editores).
- Não esqueça de abrir uma issue e notificar a tradução do mesmo. Isso conserva a boa comunicação entre todos os editores e colaboradores do projeto.
- Certifique-se de que o artigo seja colocado no diretório da sua respectiva tecnologia (ex.: Artigo sobre JavaScript, na pasta
javascript) - Utilize notas de rodapé para termos técnicos com o seu respectivo link externo para mais informações ou alguma referência.
- As Mensagens de commits devem ser em pt-BR no modo imperativo. (ex.: Adiciona tradução Lorem Ipsum, Atualiza tradução Lorem Ipsum... )
- Caso o documento possua alguma referência para um documento em inglês, traduza o título e coloque entre parênteses (em inglês). Ex.: Um título qualquer para o documento (em inglês).
- tradução - tradução de artigo em andamento
- revisão - arquivos que estão sendo revisados
- dúvidas - espaço para sugestões e perguntas referentes ao repositório
Até o momento, contamos com as seguintes seções para inserção de novos conteúdos:
Para editores
- Crie uma nova branch para sua alteração.
- Realize as suas alterações.
- Faça o Pull Request do arquivo.
- Adicione um comentário convocando os editores (@cerebrobr/editores) para a revisão.
Para colaboradores
- Faça o fork do repositório desejado.
- Crie uma nova branch para sua alteração.
- Realize as suas alterações.
- Solicite um Pull Request.
- Adicione um comentário convocando os editores (@cerebrobr/editores) para a revisão.
- O merge só deverá ser feito após 2 ou mais editores realizarem a revisão do conteúdo.
- Mensagens de commits devem ser em pt-BR no modo imperativo. (ex.: Adiciona tradução Lorem Ipsum, Atualiza documento Lorem Ipsum... )
Já comitou com a mensagem errada? Existem 2 formas de resolver:
Primeira forma:
Seguir esse link: https://help.github.com/articles/changing-a-commit-message/
Segunda forma:
- Fechar esse pull request;
- Clonar novamente o repositório;
- Criar uma nova branch (não alterar direto na master);
- Fazer a alteração;
- Commitar com a mensagem correta;
- Enviar um novo pull request.
- recomendação - recomendação/sugestão para novo conteúdo
- atualização - atualização necessária
- sugestão - espaço para sugestões e perguntas referentes ao repositório
- importante - nota importante para colaboradores, editores e admins.
- ajuda - necessita da sua ajuda. :)
Os repositórios abaixo serão utilizados apenas para referênciar, categorizar e listar os livros, guias e documentações em pt-BR ou que foram traduzidos.
Segue o mesmo padrão mencionado no Guia para novos conteúdos.
Segue o mesmo padrão mencionado no Guia para novos conteúdos.
- nova versão - material original atualizado
- recomendação - recomendação/sugestão para nova referência
- atualização - atualização necessária
- sugestão - espaço para sugestões e perguntas referentes ao repositório
- importante - nota importante para colaboradores, editores e admins.
- ajuda - necessita da sua ajuda. :)