Formas de Contribuir

Contribuição Pública

Qualquer pessoa pode criar conteúdo para o site, mesmo sem conhecimento prévio de Markdown ou GitHub — embora aprender a utilizar ambos ajude a agilizar o processo da equipe.

No servidor do Discord, vá até o canal de fórum “website-feedback” e crie uma postagem descrevendo o que deseja contribuir preenchendo o modelo abaixo:

Problema/conteúdo:
Solução ou notas sobre a execução do conteúdo:
Quando você planeja terminar?:
Usando uma plataforma alternativa ou fazendo fork no GitHub?:

Isso evita que você gaste tempo em algo fora do escopo do site ou em um tema que já esteja sendo desenvolvido por outra pessoa.

Após aprovação dos mantenedores, a postagem receberá a tag de aprovado (“green-lit”) ou você será orientado a somar forças em uma discussão já existente.

Ao começar a produzir, você pode escolher:

1. Fazer um fork do repositório no GitHub e enviar Pull Requests com as alterações (recomendado para quem tem familiaridade com Git/código).
2. Redigir em uma plataforma alternativa (como Google Docs ou Notion) para que um colaborador da equipe faça a inclusão no site.

Configurando GitHub e VS Code para Contribuir

Instalar Pré-requisitos

Baixe as versões adequadas para seu sistema operacional (Windows, Mac ou Linux). No Windows, prefira quase sempre a versão de 64 bits.

• A versão mais recente do Git
  • Siga as instruções do instalador mantendo as opções padrão
• Node.js LTS
  • Baixe a versão estável (LTS) recomendada para seu sistema operacional
  • Mantenha as opções padrão na instalação
• VS Code
  • Baixe a versão estável para seu OS
• GitHub Desktop (Opcional - você também pode usar a aba de controle de versão nativa do VS Code)
  • Após instalar, selecione “Sign in to GitHub.com”
  • Faça login ou crie sua conta no GitHub e autorize o GitHub Desktop
  • Conclua a configuração inicial

Passos para Começar a Escrever Contribuições

Para Colaboradores Públicos:

1. Acesse o repositório oficial no GitHub.
2. Clique no botão “Fork” no canto superior direito e confirme em “Create Fork”.
3. Abra o GitHub Desktop e selecione “Clone a repository from the Internet…” (ou menu File -> Clone repository...).
4. Na aba “GitHub.com”, selecione seu repositório bifurcado [seu-usuario]/FRCDesign.org e clique em “Clone”.
5. Quando o clone for concluído, selecione “To contribute to the parent project” e clique em “Continue”.

Para Mantenedores Internos:

1. Abra o GitHub Desktop e vá em File -> Clone repository....
2. Em “GitHub.com”, selecione o repositório principal e clique em “Clone”.

Como Criar Branches e Enviar Pull Requests:

1. Crie uma nova branch clicando no menu “Current branch” no topo do GitHub Desktop, clique em “New branch”, escolha um nome descritivo (ex: melhorias-intake ou guia-estilo) e clique em “Create branch”.
   • Sempre faça alterações em branches dedicadas (nunca diretamente na main).
   • Clique em “Publish branch” para enviar sua nova branch ao GitHub.
2. Clique em “Open in Visual Studio Code” para abrir a pasta do projeto.
3. Se aparecer a mensagem “Do you trust the authors of the files in this folder?”, marque a opção de confiar e confirme.
4. Ajuste suas preferências no VS Code (extensões como “Code Spell Checker” são muito úteis).
5. Faça as alterações desejadas.

Dica

Todas as páginas e pastas de conteúdo do site ficam localizadas em src/content/docs.

Adicionando uma nova página

Se você criar um novo arquivo .mdx, deve adicionar a entrada correspondente em src/config/sidebarConfig.ts para que a página apareça na barra de navegação lateral. Veja o guia Adicionando uma Página para instruções completas.

6. Ao concluir uma etapa de trabalho, faça um “commit” com uma mensagem clara resumindo o que foi feito.
7. No GitHub Desktop, confirme o commit clicando em “Commit to [sua-branch]”.
8. Clique em “Push origin” para subir seus commits para a nuvem.

Dica

Clicar no botão “Fetch origin” sincroniza qualquer alteração recente feita por outros colaboradores no repositório.

9. Para manter sua branch atualizada com as mudanças recentes da branch main, clique no menu “Branch” e selecione “Update from main”.

Dica

Atualize sua branch frequentemente com a main para evitar conflitos de mesclagem (merge conflicts).

10. Quando suas alterações estiverem concluídas e testadas, clique em “Create Pull Request” no GitHub Desktop. Isso abrirá o GitHub no seu navegador para que você descreva suas melhorias e envie para revisão. Um dos mantenedores revisará suas alterações antes de aceitá-las na branch principal.

Como Executar a Pré-visualização Local do Site

Você pode rodar o site no seu próprio computador para ver as alterações em tempo real:

1. Abra a pasta do repositório no VS Code.
2. Abra o terminal integrado com o atalho Ctrl + J (ou Ctrl + ').
3. No terminal, execute npm install para instalar as dependências do projeto (necessário apenas na primeira vez).
4. Execute npm run dev para iniciar o servidor de desenvolvimento.
5. Quando a inicialização concluir, acesse http://localhost:4321 no seu navegador.

Dica

Para encerrar a execução do servidor local, clique no terminal e pressione Ctrl + C.

Nota

Ao trocar de branch no GitHub Desktop, o servidor de desenvolvimento local atualiza o conteúdo automaticamente.