Pular para o conteúdo
Nesta página

Como Contribuir para o Career Topologies

Obrigado pelo interesse em contribuir! Este projeto é open source e colaborações são muito bem-vindas. Aqui está como você pode ajudar:

Formas de Contribuir

1. Dê uma Estrela

A forma mais simples de apoiar o projeto é dando uma estrela no repositório!

2. Reporte Bugs ou Problemas

Encontrou algo errado?

  • Abra uma Issue
  • Descreva o problema claramente
  • Inclua exemplos se possível

3. Sugira Melhorias

Tem ideias para melhorar o framework?

  • Abra uma Issue com a tag enhancement
  • Explique sua proposta
  • Descreva o benefício para os usuários

4. Melhore a Documentação

  • Corrija erros de digitação ou gramática
  • Adicione exemplos práticos
  • Esclareça seções confusas
  • Traduza para outros idiomas

5. Contribua com Código/Conteúdo

  • Crie novos templates
  • Desenvolva guias práticos
  • Adicione exemplos de ladders por área
  • Melhore visualizações e diagramas

6. Compartilhe Experiências

  • Relate como implementou o framework na sua empresa
  • Compartilhe aprendizados e adaptações
  • Participe de discussões nas Issues

Processo de Contribuição

Para Mudanças Pequenas (typos, correções, melhorias pontuais)

  1. Fork o repositório
  2. Crie uma branch: git checkout -b fix/typo-manifesto
  3. Faça suas mudanças
  4. Commit: git commit -m "fix: corrige typo no manifesto"
  5. Push: git push origin fix/typo-manifesto
  6. Abra um Pull Request

Para Mudanças Grandes (novos documentos, features)

  1. Abra uma Issue primeiro descrevendo sua proposta
  2. Aguarde feedback/aprovação
  3. Siga o processo acima após aprovação

Diretrizes de Contribuição

Documentação

  • Onde editar: o conteúdo do framework é o markdown em docs/pt-BR/, guides/pt-BR/ e templates/, na raiz do repositório. O site publica esses arquivos; não edite site/content/, que é uma cópia gerada no build
  • Linguagem: Clara, objetiva e acessível
  • Estrutura: Siga o padrão existente (headings, formatação)
  • Frontmatter: todo arquivo publicado começa com title, description, published e updated (AAAA-MM-DD); ao mudar o texto, atualize updated
  • Níveis e termos: use os níveis de 1 a 8 e os cargos da Tabela de Níveis, "bandas salariais" e as camadas First-Line Manager, Middle Manager e Senior Leader. Em pt-BR, mantenha em inglês só cargos e termos de mercado (IC, Staff, Tech Lead, shapes, as camadas de gestão)
  • Links: Sempre use caminhos relativos, com âncora quando apontar para uma seção (por exemplo, ./04-nivelamento.md#tabela-de-níveis)
  • Imagens: Coloque em assets/. Os diagramas dos modelos e das camadas de gestão são gerados a partir de site/src/lib/framework.ts com node site/scripts/generate-diagrams.mjs; não os edite à mão
  • Inglês (en-US): a tradução está desatualizada em relação ao pt-BR; a revisão completa está planejada

Modelo de página

---
title: "Título da página"
description: "Uma frase de até 160 caracteres para buscadores."
published: AAAA-MM-DD
updated: AAAA-MM-DD
---
# Título da página

Texto em pt-BR, com links relativos para outros capítulos, como [Nivelamento](./04-nivelamento.md).

Para publicar uma página nova no site, siga "Adding New Pages" em site/CONTRIBUTING.md.

Código de Conduta

  • Seja respeitoso e construtivo
  • Evite linguagem ofensiva ou discriminatória
  • Foque no problema, não na pessoa
  • Aceite feedback com mente aberta

Estilo de Escrita

Português (pt-BR):

  • Use linguagem neutra de gênero quando possível
  • Prefira "profissional" a "profissional(a)"
  • Seja inclusivo

English (en-US):

  • Use American English spelling
  • Keep language professional and inclusive

Commits

Use commits semânticos:

  • feat: para novos recursos
  • fix: para correções
  • docs: para documentação
  • style: para formatação
  • refactor: para refatorações
  • test: para testes

Exemplo: docs: adiciona seção de competências em nivelamento

Tradução

Quer traduzir para outro idioma?

  1. Crie pasta docs/[código-idioma]/ (ex: docs/es-ES/)
  2. Traduza os arquivos mantendo estrutura
  3. Atualize README principal com link para novo idioma
  4. Abra PR com tag translation

Testando Suas Mudanças

Antes de abrir PR:

  • Rode pnpm build e pnpm test em site/ (os testes conferem links, âncoras, níveis e termos)
  • Verifique links quebrados
  • Confirme que Markdown renderiza corretamente
  • Revise gramática e ortografia
  • Certifique-se de que imagens carregam

Contato

Dúvidas sobre como contribuir?

Sobre o projeto

Desenvolvido por Gui Santos: GitHub · LinkedIn · Linktree

Draft Original

Acesse o quadro Miro com o rascunho original do projeto.

Licença

Ao contribuir, você concorda que suas contribuições sejam licenciadas assim: conteúdo (documentação, guias, templates e diagramas) sob CC BY 4.0; código do site (site/) sob a licença MIT.

Agradecimentos

Obrigado por dedicar seu tempo para melhorar o Career Topologies!

Toda contribuição, grande ou pequena, é valorizada.

Atualizado em