Avançar para o conteúdo principal

Colaboradores

Diretrizes para enviar contribuições para a comunidade Celo.

O Celo é de código aberto e nós saudamos a participação livre. Nós nos esforçamos para cumprir nossos Tenets da Comunidade sendo uma comunidade aberta e inclusiva onde todos se sentem bem-vindos e capacitados a contribuir. Isso também significa seguir algumas regras básicas e cumprir o Código de Conduta de Celo.

tip

Uma lista de participantes ativos pode ser encontrada em celo.org/about

Como contribuir​

Nossa comunidade inclui um grupo de colaboradores que ajudam a desenvolver, escrever, traduzir e melhorar Celo. Qualquer pessoa é bem-vindo a participar da comunidade e contribuir com suas habilidades para ajudar a capacitar outros membros da comunidade e crescer o ecossistema Celo.

Diretrizes de Colaboradores Celo​

Existem algumas regras básicas para contribuir:

  • PRs (pull requests) são preferidas a problemas, especialmente para pequenas alterações como typos. Os problemas devem ser usados para recursos que faltam e para alterações amplas.
  • Para trabalhos contínuos, use sua própria ramificação lateral e não a ramificação principal.
  • Para quantidades não triviais de trabalho, recomendamos que você envie PRs regularmente para solicitar seus comentários.
  • Por favor, verifique seu trabalho antes de enviá-lo. Submissões com tipos, ortografia e erros gramaticais podem não ser mescladas até a correção.
  • Tente permanecer o mais objetivo e baseado em fatos possível.

Enviando PRs​

Nós encorajamos você a publicar uma PR (pull request) seu trabalho regularmente e muitas vezes a solicitar feedback e a garantir que todos tenham uma ideia do que você está trabalhando. Se você acabou de começar, sugerimos criar um PR com "WIP" (Trabalho em curso) no título e avise-nos quando estiver pronto para revisar os comentários.

🖥️ Código​

Contribuidores do Código são desenvolvedores da comunidade Celo que contribuem para o Celo monorepo ou o código central do protocolo. Eles ajudam a melhorar o protocolo e a infraestrutura consertando bugs e projetando novos recursos que ajudam a melhorar a plataforma Celo.

Como começar​

Encontre uma área que seja interessante e você gostaria de ajudar. Procurar por issues que são marcadas como "boa primeira issue", "help wanted" e "1 hora de tarefas" para começar. Se você quiser se aprofundar, sinta-se à vontade para ver outros rótulos e TODO's nos comentários do código. Se houver algum problema em que você esteja interessado em contribuir ou assumir o controle atribua a você mesmo e adicione um comentário com seus planos para o endereço e linha do tempo alvo. Se já houver alguém designado a ele, por favor cheque com eles antes de adicionar você mesmo à lista de responsáveis.

As tarefas variam entre pequenas e grandes melhorias. Com base em seus interesses, conjunto de habilidades e nível de conforto com a base de código, sinta-se à vontade para contribuir onde você achar apropriado. A única coisa que lhe pedimos é que siga as orientações abaixo para assegurar uma colaboração eficiente e tranquila.

Certifique-se de seu PR​

  • Solicita os revisores apropriados. Na dúvida, consulte o arquivo CODEOWNERS para obter sugestões.
  • Fornece uma descrição abrangente do problema abordado e as alterações feitas.
  • Explora dependências e alterações incompatíveis retroativas.
  • Contém testes de unidade e de ponta a ponta e uma descrição de como foram executados.
  • Inclui alterações na documentação relevante.

Se você estiver enviando um problema, verifique se ainda não existe um problema para o trabalho que você tem em mente.

Por favor, certifique-se de seu problema​

  • Foi criado no repositório correto.
  • Tem um título claro e detalhado, tal que não pode ser confundido com outros problemas do Celo.
  • Fornece uma descrição completa do comportamento atual e esperado, incluindo, se relevante, links para referências externas e diretrizes de implementação específicas.
  • Está marcado com os rótulos relevantes.
  • É atribuído se você ou outra pessoa já estiver trabalhando nele.

🤝 CIPs​

Propostas de Melhoria da Celo (CIPs) descrevem os padrões para a plataforma Celo e incluindo as especificações do protocolo central, o SDK e os padrões do contrato. Um CIP é um documento de design que deve fornecer informações de segundo plano, uma lógica para a proposta, solução pormenorizada, incluindo especificações técnicas e, se for caso disso, uma lista de riscos potenciais. O proponente é responsável por solicitar feedback comunitário e promover consenso.

Enviando CIPs​

Trate todas as propostas seguindo o modelo abaixo e submeta para o repositório CIPs através de um PR (pull request).

Modelo CIP​

  • Resumo: Descreva sua proposta com 280 caracteres ou menos.
  • Abstract: Forneça uma breve descrição do problema técnico a ser resolvido.
  • Motivação: Explique claramente por que a mudança proposta deve ser feita. Deve formatar as lacunas do actual protocolo Celo que aborda e por que razão fazê-lo é importante.
  • Especificação: Defina e explique em detalhe os requisitos técnicos para novos recursos e/ou alterações propostas.
  • Justificativa: Explique o raciocínio por trás da sua abordagem. Deverá abranger abordagens alternativas consideradas, relacionadas com o trabalho e contrapartidas feitas.
  • Implementação: Para todas as propostas que passam pelo processo de governança, esta seção deve fazer referência ao código que implementa a mudança proposta. É recomendado obter feedback da comunidade antes de escrever qualquer código.
  • Riscos: Destaque quaisquer riscos e preocupações que possam afetar o consenso, proof-of-stake, governança, economia do protocolo, o protocolo de estabilidade, segurança e privacidade.

📄 Documentos​

Escritores técnicos apoiam a comunidade Celo educando desenvolvedores sobre Celo através de documentação envolvente, informativa e perspicaz.

Assista ao vídeo ↗️

Editar uma página existente​

Para editar uma página existente na documentação, crie um fork do repositório, comprometa as suas edições e envie uma versão PR.

  • Ir para a página nos documentos
  • Clique em Editar esta página na parte inferior da página
  • Edite a página diretamente no GitHub
  • Descrever a edição no commit
  • Selecione "Criar um novo branch e inicie uma pull request"
  • Descrever alterações no Pull Request (PR)
  • Selecione "joenyzio" como revisor
  • As mudanças devem ser aprovadas e passar por todas as verificações de compilação do site antes de serem mescladas.

Adicionar/remover páginas​

Para adicionar uma nova página à documentação, crie um fork, adicione as novas páginas e atualize a tabela de arquivos de conteúdo para incluir suas novas páginas no local apropriado e envie uma PR.

  • Adicionar ou excluir páginas diretamente no Github
  • Colocar novas páginas onde você acha que faz mais sentido, nós podemos movê-las mais tarde
  • Crie um PR para que suas alterações sejam adicionadas à versão ao vivo do site
  • Atualizar o arquivo chamado "sidebars.js" na pasta principal
  • Este arquivo contém o layout do site que você vê no lado esquerdo do site
  • Adicione ou remova os arquivos apropriados da lista

🎓 Tutoriais​

Escreva sobre sua experiência como membro da comunidade Celo, seja você proprietário, desenvolvedor ou fundador de um projeto CELO. A sua experiência e perspectiva são valiosas e podem ajudar outros.

Nome do arquivo:​

Criar uma nova postagem no blog é simples. Crie um novo arquivo no diretório blog no repositório da documentação. Os nomes dos arquivos seguem o formato de YYYY-MM-DD-post-name.md. Por exemplo, esta postagem foi escrita em 8 de novembro de 2021, portanto, tem o nome de arquivo 2021-11-08-contributing.md.

Material Inicial​

Publicações são escritas em Markdown. As postagens incluem matéria inicial. A matéria inicial são os metadados do arquivo na parte superior do arquivo que fornecem mais informações sobre a postagem. O assunto inicial deste post é assim:

---
title: Contributing to the Blog
description: How to contribute to the blog
slug: blog-contributions
authors:
  - name: Josh Crites
    title: Developer Relations, cLabs
    url: https://github.com/critesjosh
    image_url: https://github.com/critesjosh.png
tags: [contribute]
image: https://i.imgur.com/mErPwqL.png
hide_table_of_contents: false
---

Resumo da publicação​

As páginas também podem incluir um <! -truncate--> marcador que especifica qual texto será mostrado juntamente com o título da postagem na página de lista. Qualquer texto acima de <!--truncate--> será exibido como um resumo da mensagem.

Adicionando recursos estáticos​

Se você gostaria de incluir imagens ou outros arquivos estáticos em uma publicação, você pode criar uma pasta seguindo a convenção de nomes descrita acima (AAAA-MM-DD-post-name). O conteúdo da pasta pode incluir as imagens e o post (com o nome de arquivo index.md).

🌐 Traduções​

Os tradutores apoiam a comunidade expandindo o Celo para comunidades que não falam inglês, traduzindo e compartilhando conteúdo em diferentes idiomas.

Como contribuir​

  • Acesse https://celo.crowdin.com/
  • Criar uma conta
  • Iniciar tradução
  • Envie perguntas com Mensagens do Crowdin
  • Solicitação de tradução
tip

Para perguntas, comentários e discussões, por favor, use o Celo Fórum ou Discord.