Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 3.08 KB

CONTRIBUINDO.md

File metadata and controls

85 lines (53 loc) · 3.08 KB

Contribuições

Por onde começar?

  1. Faça o fork do projeto;
  2. Entenda o fluxo de contribuições;
  3. Leia e pratique as boas práticas;

Fluxo

É muito fácil contribuir para o projeto e iniciantes no universo Open Source são mais do que bem-vindas(os)!

Qualquer tipo de ajuda (seja ela grande ou pequena) é válida e construtiva. Se encontrar qualquer parte do livro que possa ser melhorada, essa é uma grande oportunidade para participar.

E caso não saiba por onde começar:

  1. Faça referência ao repositório oficial após o fork

git remote add upstream git@github.com:okrdu/sicp-ptbr.git

  1. Antes de iniciar o processo de contribuição, crie uma nova branch para fazer suas alterações.

Alguns exemplos:

  • Para tradução: git checkout -b traducaoCapX
  • Para revisões: git checkout -b revisaoCapX
  • Para erros: git checkout -b correcaoCapX

Use qualquer nome que seja coerente com a contribuição que está sendo feita. X representa o número do capítulo.

  1. Após realizar as alterações, é hora de fazer um commit com uma mensagem coerente do que foi feito. Exemplo:

git add --all
git commit -am ‘Adiciona tradução/revisão/melhoria capítulo X linha/linhas Y
git push origin traducaoCapX

  1. Envie um Pull Request com as alterações feitas, fazendo referência para o master do repositório oficial.

  2. Sua contribuição será analisada pela comunidade. Em alguns casos pediremos algumas alterações antes de dar merge.

Após o merge:

Delete a branch utilizada:

git checkout master
git push origin traducaoCapX
git branch -D traducaoCapX

Atualize seu repositório com o repositório oficial:

git fetch upstream
git rebase upstream/master
git push -f origin master

  1. Quando iniciar uma nova contribuição, inicie repita o processo pelo passo 2.

Boas Práticas

  • Não traduza termos técnicos e blocos de código
  • Antes de enviar sua contribuição, certifique-se de que está enviando apenas um único commit que represente o que foi feito. Caso tenha feito vários commits, esmague-os antes de fazer o Pull Request.
  • Caso tenha qualquer tipo de dúvida, abra uma Issue que faremos o possível para te ajudar.
  • Contribua com as discussões.
  • Estrangeirismo: Utilizar o formato itálico. Exemplo: bug
  • Sentido Figurado: Sempre destacar com aspas duplas.
  • Citação: Aspas duplas com o sinal de >. Exemplo:

“Foo bar”

  • Marcação para código: Utilizar um apóstrofe (`) para indicar um pedaço de código no meio de um texto (var foo = undefined). Ou três apóstrofe com o nome da linguagem de programação na frente (```scheme), para indicar um bloco de código:
(display "Hello, World!")

Esse texto é um documento em constante edição, e pode ser alterado no futuro.

Um agradecimento especial ao BrazilJS por possibilitar a adaptação de sua documentação!

<--- Voltar à Página Inicial