Skip to content

Guia de Contribuição

Obrigado por querer contribuir com o Roadmap Developer 2026! Este projeto é mantido pela comunidade para ajudar desenvolvedores a se manterem atualizados.

🚀 Como Rodar o Projeto Localmente

Este projeto usa VitePress para gerar o site estático.

Pré-requisitos

  • Node.js (versão 18 ou superior)
  • NPM ou Yarn

Passos

  1. Clone o repositório:

    bash
    git clone https://github.com/seu-usuario/roadmap-developer-2026.git
    cd roadmap-developer-2026
  2. Instale as dependências:

    bash
    npm install
  3. Rode o servidor de desenvolvimento:

    bash
    npm run docs:dev

    O site estará disponível em http://localhost:5173. As mudanças nos arquivos Markdown são refletidas instantaneamente.

  4. Verifique o Build de Produção: Antes de enviar suas mudanças, verifique se o build passa sem erros:

    bash
    npm run docs:build

📝 Como Contribuir com Conteúdo

  1. Estrutura: Todo o conteúdo está na pasta roadmaps/.

  2. Imagens: Use a sintaxe padrão do Markdown. Para diagramas, prefira usar Mermaid dentro de blocos de código:

    markdown
    ```mermaid
    flowchart TD
      A[Start] --> B{Is it?}
      B -- Yes --> C[OK]
      B -- No --> D[Rethink]
    ```
  3. Links: Verifique se os links que você adicionou funcionam e são relevantes.

  4. Estilo: Mantenha um tom encorajador, prático e direto.

🤝 Pull Requests

  1. Crie uma branch para sua feature (git checkout -b feature/novo-conteudo).
  2. Faça o commit das suas alterações.
  3. Abra um Pull Request descrevendo o que você mudou e por quê.

Obrigado por ajudar a comunidade! 🚀

🔄 CI/CD Guidelines

When creating a pull request:

  1. Ensure all linting checks pass: npm run lint and npm run lint:md and npx prettier --check .
  2. Ensure unit tests pass with at least 80% coverage: npm run test:coverage
  3. Ensure E2E tests pass: npm run test:e2e
  4. Make sure your PR resolves all CI/CD failures before requesting a review.

Lançado sob a licença MIT.