Pular para o conteúdo principal

Como Contribuir

Este guia oferece um caminho simples e direto para realizar sua primeira contribuição aprovada. Não é necessário ter experiência prévia com projetos open source — qualquer pessoa pode participar e fazer a diferença.

Seja corrigindo um erro de português ou criando um tutorial completo, cada contribuição fortalece nossa comunidade.

Início Rápido (5 minutos)​

Contribuições sem código​

Essas são ótimas opções para começar a contribuir com rapidez e impacto, sem necessidade de ambiente técnico:

  • Corrigir erros de digitação - Encontrou um erro de português ou formatação? Clique em "Editar esta página" no rodapé e envie sua sugestão
  • Aprimorar exemplos - Atualize exemplos existentes ou inclua variações mais claras e contextualizadas para a realidade brasileira
  • Reportar problemas - Identificou informações confusas, incorretas ou desatualizadas? Registre uma issue com uma descrição clara do que pode ser melhorado

Link Direto para Contribuir​

Configuração do Ambiente​

Pré-requisitos​

Para edições simples:

  • Conta no GitHub
  • Navegador web (qualquer um)
  • Conhecimento básico de Markdown

✅ Você pode contribuir diretamente pelo GitHub web!

Setup Local (Contribuição Local)​

# <ion-icon name="document-text-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> 1. Fork e clone o repositório oficial da documentação brasileira do n8n
# <ion-icon name="grid-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> (faça o fork para sua conta antes de clonar, se for contribuir)
git clone https://github.com/tatyquebralayout/n8n-Doc-pt-BR.git
cd n8n-Doc-pt-BR

# <ion-icon name="settings-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> 2. Instalar dependências
npm install

# <ion-icon name="code-slash-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> 3. Iniciar servidor de desenvolvimento
npm start

# <ion-icon name="document-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> 4. Abrir no navegador
# <ion-icon name="document-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> http://localhost:3000
Dica importante

Lembre-se de fazer o fork para sua conta no GitHub antes de clonar, caso queira enviar contribuições!

Fluxo de Contribuição​

Método 1: Edição Rápida (GitHub Web)​

Ideal para: Correções simples, typos, pequenas melhorias e quem está começando

  1. Navegue até a página que quer editar
  2. Clique em "Editar esta página" no final
  3. GitHub criará automaticamente um fork
  4. Faça suas alterações no editor web
  5. Adicione uma descrição clara das mudanças
  6. Clique em "Propose changes"
  7. Envie o Pull Request
dica
Vantagem

Você não precisa instalar nada! Tudo acontece no navegador.

Método 2: Desenvolvimento Local​

Recomendado para contribuições que envolvem múltiplos arquivos, criação de novos conteúdos ou personalizações mais avançadas. Ideal para pessoas com familiaridade com linha de comando e ambiente de desenvolvimento local.

# Criar uma nova branch para sua contribuição
git checkout -b minha-contribuicao

# Verificar arquivos modificados
git status

Padrão de nomes para branchs:

  • fix/corrigir-typo-instalacao
  • feat/novo-tutorial-webhook
  • docs/atualizar-guia-docker

Tipos de Contribuição​

Criar Novo Conteúdo​

Use seu conhecimento para expandir a documentação. Essas contribuições ajudam outras pessoas a resolverem desafios reais no uso do n8n.

Tutoriais Práticos

  • Workflows
  • Integrações passo a passo
  • Casos de uso aplicados ao dia a dia
  • Soluções para problemas comuns

Guias de Integração

  • Integração com APIs nacionais (ex: ViaCEP, Receita Federal)
  • Conexão com sistemas de pagamento no Brasil
  • Configuração de ERPs usados localmente
  • Automação com plataformas de comunicação e redes sociais

Template para novos tutoriais​

Use este modelo para criar tutoriais claros, testáveis e contextualizados para a comunidade brasileira.

---
title: Integração com [Nome do Serviço]
description: Guia passo a passo para conectar o n8n com [Nome do Serviço] usando recursos locais
keywords: [n8n, integração, brasil, [serviço], automação]
---

# <ion-icon name="git-network-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> Integração com [Nome do Serviço]

:::tip[Resultado esperado]
Ao final deste tutorial, você terá um fluxo funcional que [explique brevemente o objetivo, por exemplo: envia notificações via WhatsApp, consulta CEPs automaticamente etc.].
:::

## <ion-icon name="grid-outline" style={{ fontSize: '24px', color: '#ea4b71' }}></ion-icon> Pré-requisitos

- [ ] Acesso ao n8n (local ou em nuvem)
- [ ] Conta ativa em [Nome do Serviço]
- [ ] [Outros itens necessários, como chaves de API, permissões, etc.]

## <ion-icon name="document-text-outline" style={{ fontSize: '24px', color: '#ea4b71' }}></ion-icon> Etapas do Tutorial

### 1. Visão Geral
Breve explicação sobre o que será feito e por quê essa integração é útil.

### 2. Preparação
Descreva como obter as credenciais ou configurar permissões no serviço externo.

### 3. Configuração no n8n
Passo a passo com capturas de tela e explicações para cada nó utilizado:
- Criar novo workflow
- Adicionar e configurar os nós
- Testar individualmente os componentes

### 4. Execução e Validação
- Execute o workflow
- Verifique se os dados foram processados corretamente
- Dicas de verificação e logs úteis

## <ion-icon name="chevron-forward-outline" style={{ fontSize: '24px', color: '#ea4b71' }}></ion-icon> Testando

Como validar que tudo está funcionando:
- Exemplo de input real
- Resultado esperado
- Mensagens de erro comuns e como resolver

## <ion-icon name="arrow-forward-circle-outline" style={{ fontSize: '24px', color: '#ea4b71' }}></ion-icon> Próximos Passos

- [ ] Links para tutoriais relacionados
- [ ] Sugestões de melhorias no fluxo
- [ ] Casos de uso complementares

Melhorias Existentes​

Exemplos de melhorias bem-vindas:

  • Atualizar screenshots desatualizados
  • Adicionar exemplos brasileiros mais relevantes
  • Corrigir informações desatualizadas
  • Melhorar clareza das explicações
  • Adicionar troubleshooting para problemas comuns

Melhorias Visuais​

  • Screenshots em alta qualidade
  • Diagramas explicativos
  • GIFs demonstrativos
  • Vídeos tutoriais (YouTube embeds)

Checklist de Qualidade​

Antes de Enviar​

Qualidade do Texto

  • Português brasileiro correto
  • Tom conversacional e amigável
  • Exemplos contextualizados para o Brasil
  • Links internos funcionando
  • Informações atualizadas

Estrutura

  • Usa template padrão
  • Hierarquia de títulos correta
  • Admonições apropriadas (tip, warning, etc.)
  • Cross-references relevantes

Processo de Revisão​

O que Acontece Após Enviar​

  1. Revisão Automática (2-5 min)

    • Verificação de build
    • Testes de links
    • Validação de formatação

  2. Revisão Humana (1-3 dias)

    • Qualidade do conteúdo
    • Correção técnica
    • Adequação aos padrões

  3. Feedback e Ajustes (conforme necessário)

    • Sugestões de melhoria
    • Correções solicitadas
    • Ajustes de estilo

  4. Aprovação e Merge

    • Contribuição aprovada
    • Código integrado ao projeto
    • Publicação automática

Como Responder ao Feedback​

Receber sugestões é parte essencial do processo de contribuição colaborativa. Nosso objetivo é apoiar seu aprendizado e garantir que sua contribuição brilhe.

O que fazer ao receber feedback:

  • Leia com abertura e empatia. Toda sugestão visa aprimorar o conteúdo de forma colaborativa.
  • Implemente as mudanças solicitadas, quando fizer sentido. Se tiver outra abordagem, explique gentilmente seu ponto de vista.
  • Peça esclarecimentos se algo não estiver claro — estamos aqui para ajudar!
  • Agradecemos sua disposição em evoluir junto com o projeto. Feedback é um presente.

Como aplicar os ajustes no seu PR:

# <ion-icon name="document-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> Faça as edições solicitadas
# <ion-icon name="server-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> (edite os arquivos conforme o feedback)

# <ion-icon name="document-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> Adicione as alterações
git add .

# <ion-icon name="git-branch-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> Faça um commit descritivo
git commit -m "fix: ajustes conforme feedback da revisão"

# <ion-icon name="git-branch-outline" style={{ fontSize: '32px', color: '#ea4b71' }}></ion-icon> Envie as atualizações para o seu fork
git push origin minha-contribuicao
Importante

✅ O Pull Request será atualizado automaticamente — não é necessário criar um novo.

### FAQs da Contribuição

❓ Não sei por onde começar

Resposta: Comece com issues marcadas como 

good first issue
. São problemas simples perfeitos para primeira contribuição!

Links úteis:

❓ Minha ideia já existe?

Resposta: Antes de começar, procure por:

  1. Issues existentes relacionadas
  2. PRs em andamento
  3. Conteúdo similar na documentação

Se não encontrar nada, abra uma issue para discutir sua ideia!

❓ Quanto tempo demora para aprovar?

Resposta:

  • Correções simples: 1-2 dias
  • Conteúdo novo: 3-7 dias
  • Mudanças grandes: 1-2 semanas

Tentamos ser rápidos, mas priorizamos qualidade!

❓ Posso contribuir sem saber programar?

Resposta: Claro! Muitas contribuições valiosas não envolvem código:

  • Melhorar textos e correções
  • Adicionar exemplos e casos de uso
  • Reportar problemas e sugestões
  • Revisar conteúdo de outras pessoas
  • Traduzir e localizar conteúdo
  • Criar diagramas e imagens explicativas
  • Testar tutoriais e dar feedback

Recursos para Continuar​

Pronto para contribuir? Escolha uma issue marcada como 
good first issue
e siga este guia. A comunidade está aqui para ajudar em cada passo! Todas as pessoas são bem-vindas, independente do seu nível de experiência.

Ver Issues Disponíveis | Fazer uma Pergunta