| title | date | categories | tags | author | description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Faça Parte: Guia Para Colaboração |
2022-03-22 |
|
|
|
Cypherpunks Brasil é um projeto voluntário que depende da contribuição de todos que desejam manter e crescer o projeto. Nesse guia apresentamos diversas formas de contribuir com o projeto |
Cypherpunks Brasil depende da contribuição voluntária de todos que desejam manter e crescer o projeto. Fizemos muito até aqui e queremos continuar. Nesse guia apresentamos diversas formas de contribuir com o projeto
- Adicionando novos Documentos
- Traduzindo Documentos para Português (pt-br)
- Revisando e corrigindo Documentos já traduzidos
- Melhorando nosso site cypherpunks.com.br
- Iniciando, liderando ou auxiliando a criação de novos projetos
- Divulgando o Cypherpunks Brasil
No Github você só pode alterar projetos que você mesmo tenha criado, ou seja, somente os repositórios que estiverem em github.com/seu-nome-de-usuário/nome-do-seu-projeto poderão ser alterados diretamente por você. De qualquer forma, isso não te impede de enviar contribuições para projetos criados por outras pessoas. Por exemplo, para contribuir com o nosso projeto, em vez de editar o repositório original github.com/cypherpunksbr/documentos, você deve:
- Fazer uma cópia (Fork) desse repositório
- Após o Fork, você terá uma cópia exata do repositório original
github.com/cypherpunksbr/documentosque estará emgithub.com/seu-nome-de-usuário/documentos
-
Criar uma "área de trabalho" (Branch) para fazer suas alterações
-
Fazer as alterações na sua cópia
github.com/seu-nome-de-usuário/documentose dentro da branch criada no passo anterior -
"Enviar" suas alterações através de uma Pull Request (PR)
Tutorial completo de como executar cada um desses passos diretamente pelo site do Github
Você pode adicionar qualquer tipo de documento relacionado ao movimento cypherpunk à nossa biblioteca
Dica: algumas palavras contém links que te levam a uma explicação de como fazer
1. Faça um Fork do nosso repositório no github.
2. Dentro de seu Fork, crie uma nova Branch com um nome que especifique o objetivo. Por exemplo adiciona-bitcoin-whitepaper. Após criar essa branch, é dentro dela que você irá trabalhar.
3. Encontre o documento que deseja traduzir na internet, em livros, qualquer lugar, ou escreva você mesmo um texto autoral. Salve as informações importantes (link para a página web, nome do livro, autor, data de publicação e poss), elas serão usadas nas próximas etapas. O documento pode estar em qualquer idioma, incluindo o português (pt-br).
4. No seu fork, dentro da branch criada, salve o documento em um arquivo único de texto com extensão .md (Markdown). Se for um documento em língua estrangeira, salve-o na pasta /para traduzir/. Se for um documento em Português (pt-br), salve-o na pasta /para revisar/. Caso o documento contenha imagens ou outros arquivos adicionais, salve esses arquivos na pasta /stuff/. No futuro você irá referenciar esses arquivos usando markdown caso necessário.
5. Formate o documento para seguir o padrão dos textos publicados. Formate o texto usando o padrão de sintaxe Markdown. Tome cuidado para não esquecer de formatar nada, reconstrua as referências de links que estão no site, palavras em itálico, citações, parágrafos, imagens, tudo! Isso precisa estar muito bem feito para que quem venha a traduzir e ler o documento não fique com um texto mal formatado.
6. Adicione nosso cabeçalho. Esse cabeçalho serve para que nosso site (feito com Hugo) reconheça informações importantes e agregue isso na exibição ao leitor. Adicione o cabeçalho a seguir no início do documento, alterando as informações pelas informações do seu texto. Caso alguma das informações exigidas não faça sentido para o caso do seu documento, apague a linha:
---
title: 'Título do Seu Documento Aqui'
date: data da publicação no formato dia-mês-ano (exemplo: 31-10-2008)
categories:
- Artigo (ou o que faz mais sentido. ex: livro, glossário, tutorial, etc.)
author:
- Nome Do Autor
- Nome De Outros Autores Se Tiver, Um Por Linha
tags:
- tag util 1 sem aspas
- tag util 2 sem aspas
- tag util 3 sem aspas
description: 'Escreva aqui uma breve descrição sobre o documento. Essa descrição irá aparecer nos cards do site e na pré-visualização do link quando for enviado em redes sociais.'
---
Nota: aspas simples ou duplas são necessárias caso os dados contenham caracteres especiais
7. Após ter feito isso seu documento está organizado e pronto para ser incluído no repositório raiz do projeto no GitHub. Para incluí-lo é necessário realizar um Pull Request (PR) da sua branch para a branch main do repositório raiz, exemplo: cypherpunksbr/documentos | main <-- seu-nome-de-usuário/documentos | adiciona-bitcoin-whitepaper. Após ter feito o PR, aguarde um dos membros da organização revisar suas alterações e aprovar seu trabalho. Obrigado por colaborar!
Você pode traduzir qualquer documento presente na pasta /para traduzir/ ou então caso queira traduzir um documento que não está nessa pasta você pode primeiro adicionar novos Documentos à biblioteca
Dica: algumas palavras contém links que te levam a uma explicação de como fazer
1. Faça um Fork do nosso repositório no github.
2. Dentro de seu fork, crie uma nova Branch com um nome que especifique o objetivo. Por exemplo traduz-bitcoin-whitepaper. Após criar essa branch, é dentro dela que você irá trabalhar.
3. Encontre o documento que deseja traduzir dentro da pasta /para traduzir/. É nessa pasta que estão os documentos que aguardam tradução.
4. Mova o arquivo para a pasta correta. Antes de começar a traduzir é necessário que você sinalize para todos que você está traduzindo esse texto para que não aconteça de duas pessoas ao mesmo tempo estarem traduzindo a mesma coisa, gerando ineficiência e trabalho jogado fora. Para sinalizar a intenção de tradução você deve mover o arquivo do seu documento que está na pasta /para traduzir/ para a pasta /sendo traduzidos/.
5. No passo anterior você moveu o documento apenas na sua cópia (fork) do projeto. Agora para mover no repositório original você precisa abrir um Pull Request (PR) da sua branch para a branch main do repositório raiz, exemplo: cypherpunksbr/documentos | main <-- seu-nome-de-usuário/documentos | adiciona-bitcoin-whitepaper. Após ter feito o PR, aguarde um dos membros da organização aprovar. Assim que aprovado você pode ir para o próximo passo.
6. Hora de traduzir o documento! A branch que você criou anteriormente continua no seu fork e é por lá que você continuará trabalhando. Encontre seu documento que está em /sendo traduzidos/dd-mm-aaaa-nome-do-seu-documento.md e faça a tradução. Entenda:
- Você pode usar ferramentas para agilizar a tradução como por exemplo Google Translate, mas tais ferramentas as vezes alteram a formatação e o sentido dos textos, tiram expressões de contexto, erram termos técnicos, etc. Portanto você precisará revisar bem o texto caso decida usá-las;
- Não quebre a formatação do documento. Usamos o padrão de sintaxe
Markdowncom a adição de um cabeçalho no inicio do texto que orienta nosso site a classificar os documentos; - Algumas palavras não exigem tradução pois são tão difundidas como a forma original até mais do que a tradução, como por exemplo "blockchain". Nesses casos coloque a palavra seguida pela tradução entre parêntesis, depois use apenas a palavra original caso ache mais adequado;
- Caso não saiba qual a melhor traducão para um trecho de texto peça ajuda. Você pode fazer isso pedindo para um amigo, abrindo uma Issue no github ou perguntando em nosso grupo no telegram;
- Se você traduziu um pedaço do trecho mas só vai poder continuar em outro momento, não tem problema, faça Commit da alteração ou salve o que já traduziu em outro local para poder continuar de onde parou
- Faça um bom trabalho. Saiba que você está ajudando outras pessoas a terem acesso facilitado a informação de qualidade e preservando/difundindo um pedaço da história para outro idioma.
7. Mova novamente o documento de pasta. Agora você já finalizou a tradução e irá mover o documento para a pasta de revisão. Para isso você deve mover o arquivo do seu documento que está na pasta /sendo traduzidos/ para a pasta /para revisar/
8. Após mover no seu repositório, hora de replicar essa mudança no repositório original fazendo mais um Pull Request (PR) da sua branch para a branch main do repositório raiz assim como foi feito anteriormente, exemplo: cypherpunksbr/documentos | main <-- seu-nome-de-usuário/documentos | traduz-bitcoin-whitepaper. Após ter feito o PR, aguarde um dos membros da organização revisar suas alterações e aprovar seu trabalho. Obrigado por colaborar!
Você pode revisar um documento que já esteja traduzido e disponível na pasta /para revisar/ ou que já possua pelo menos uma revisão na pasta /sendo revisados/.
Dica: algumas palavras contém links que te levam a uma explicação de como fazer
1. Faça uma cópia (Fork) do nosso repositório no Github.
2. Dentro de seu Fork (github.com/seu-nome-de-usuário/documentos), crie uma nova Branch com um nome que espeficique o objetivo. Por exemplo: revisa-bitcoin-whitepaper.
3. Encontre o documento que deseja revisar na pasta /para revisar/. Caso este documento já possua pelo menos uma revisão, ele deverá estar na pasta /sendo revisados/.
Diferente do processo de tradução, o processo de revisão acontece mais de uma vez. Sendo assim, se você deseja revisar um documento que ainda está em
/para revisar/, primeiro você deve move-lo para a pasta/sendo revisados/e fazer uma Pull Request (PR). Caso já exista pelo menos uma revisão deste documento, alguém já o terá movido, então ele deverá estar na pasta/sendo revisados/
4. Na pasta correta, clique no nome do documento escolhido e habilite o modo de edição do Github clicando no lápis ✏️ (canto superior direito da tela)
5. Faça as alterações que achar necessárias
6. Terminou sua revisão? Agora você pode começar a PR!
Não se esqueça de seguir o passo a passo corretamente, escrevendo uma boa mensagem de commit e conferindo se está "enviando" as alterações da sua Branch para a Branch principal do repositório raiz. ex.:
cypherpunksbr/documentos | main<--seu-nome-de-usuário/documentos | revisa-bitcoin-whitepaper
Quer ajudar a melhorar o cypherpunks.com.br?
1. Vá até o nosso [repositório do site(https://github.com/cypherpunksbr/cypherpunks.com.br) no Github e faça o Fork.
2. Dentro do seu Fork (github.com/seu-nome-de-usuário/cypherpunks.com.br), crie uma nova Branch com um nome que especifique o objetivo. Por exemplo: corrige-link-quebrado.
3. Dentro da branch criada no passo anterior, faça suas alterações e salve tudo em um commit com uma mensagem pertinente. Por exemplo: corrige link para o canal do Youtube.
4. Faça o Pull Request (PR) e aguarde aprovação. Obrigado por colaborar!
Não se esqueça de seguir o passo a passo corretamente, escrevendo uma boa mensagem de commit e conferindo se está "enviando" as alterações da sua Branch para a Branch principal do repositório raiz. ex.:
cypherpunksbr/cypherpunks.com.br | main<--seu-nome-de-usuário/cypherpunks.com.br | corrige-link-quebrado
Está inspirado? Iniciar um projeto do zero poderia ajudar a tornar o movimento cypherpunk ainda mais forte e descentralizado! Caso tenha alguma boa ideia que possa ajudar pessoas a se libertar por meio da criptologia, não hesite em colocar isso em prática. Use todo seu potencial, mostre tudo que aprendeu, traga todos que puder e conte sempre com o nosso apoio.
