Torne um projeto público para que qualquer pessoa leia os boards, os cards e a wiki, mesmo sem conta. Pessoas de fora podem comentar, propor cards e pedir para trabalhar em cards abertos para contribuição. A equipe decide o que entra pela triagem e modera a conversa.
Este guia é para quem mantém um projeto aberto e para quem quer contribuir com um.
Versão em Markdown puro deste guia: https://app.krakendock.com/docs/open-source.md?lang=pt-BR. Use-a para colar num assistente de IA ou na documentação interna do seu time.
| Peça | Para quem | Onde |
|---|---|---|
| Visibilidade e contribuição | quem administra o projeto | Configurações do projeto → Visibilidade |
| Visão geral e README | todo mundo | https://app.krakendock.com/HANDLE/KEY |
| Página Contribuir | quem quer ajudar | https://app.krakendock.com/HANDLE/KEY/contribute |
| Triagem | mantenedores | https://app.krakendock.com/HANDLE/KEY/triage |
| Moderação | quem administra o projeto | Configurações do projeto → Moderação |
| Explorar | todo mundo | https://app.krakendock.com/explore |
| Perfil público | cada pessoa e organização | https://app.krakendock.com/HANDLE |
O caminho de uma contribuição:
Só o dono de um projeto pessoal muda a visibilidade. Num projeto de organização, é preciso a permissão de gerenciar projetos da organização. As outras opções da página pedem a permissão de gerenciar o projeto.
| Opção | O que faz |
|---|---|
| Permitir comentários de não-membros | quem tem conta com e-mail verificado comenta nos cards |
| Permitir sugestões de cards de não-membros | quem tem conta com e-mail verificado propõe cards (tipo, título e descrição) |
| Propostas externas vão para a triagem | ligada por padrão: as propostas esperam um mantenedor na Triagem. Desligada, entram direto na board |
| Guia de contribuição | uma página da wiki mostrada na página Contribuir e no formulário de proposta. Veja Guia de contribuição |
Essas opções só valem enquanto o projeto é público. Os pedidos para trabalhar num card não dependem delas: valem em todo projeto público, para os cards marcados como abertos para contribuição.
Preencha também, em Configurações → Geral, a Descrição, o Site e os Tópicos (até 10). Eles aparecem na visão geral e ajudam a encontrar o projeto no Explorar.
Sem login, um visitante lê:
As mudanças aparecem em tempo real para o visitante também. Um projeto privado responde "não encontrado" para quem não é membro: o link não revela que ele existe.
Escolha Privado e confirme em Tornar privado.
Projetos públicos são gratuitos em qualquer plano:
Os limites que não dependem da visibilidade continuam valendo, como o número de campos customizados por projeto, os formulários e chamados do Helpdesk e o armazenamento de anexos da conta. Veja os planos em https://app.krakendock.com/pricing.
O endereço do projeto (https://app.krakendock.com/HANDLE/KEY) abre a visão geral, para membros e visitantes:
Um visitante vê também o aviso Você está visitando este projeto, que diz o que ele pode fazer ali e pede login ou a confirmação do e-mail quando falta.
O README é uma página da wiki do projeto. Escolha qual em Configurações → README, no campo Página do README. Ele tem o mesmo editor, histórico e permissões da wiki. Sem README, quem administra o projeto vê na visão geral o atalho Escolher página.
Qualquer pessoa logada pode dar estrela (Favoritar) num projeto que consegue ver. Os projetos com estrela aparecem na seção Favoritos da barra lateral, no painel inicial e na aba Estrelas do perfil. O Explorar ordena projetos e organizações por estrelas.
O Explorar mostra o que é público no KrakenDock, sem precisar de conta. Ele tem as abas Visão geral, Projetos, Pessoas, Ranking e Organizações.
A aba Visão geral reúne Projetos em alta (os de atividade mais recente), Projetos novos, Pessoas em destaque, Tópicos populares e Aceitam contribuições.
A aba Projetos lista os projetos públicos com filtros:
Os números de cada projeto (cards abertos e concluídos, membros e última atividade) são atualizados a cada 5 minutos.
O Ranking mostra quem mais contribui em projetos públicos. Escolha o Período (7 dias, 30 dias ou 365 dias) e filtre por Tópico, Organização ou Tipo de contribuição. Logado, você vê Sua posição.
A pontuação, em linhas gerais:
| Tipo | Peso |
|---|---|
| Cards concluídos | 5 |
| PRs mergeados | 5 |
| Cards criados | 2 |
| Commits | 1 |
| Edições na wiki | 1 |
| Comentários | 1 |
Cada conta tem um perfil em https://app.krakendock.com/HANDLE, aberto a qualquer pessoa pelo link. O perfil tem as abas Visão geral, Projetos e Estrelas e mostra:
Configure tudo em Configurações → Perfil:
As conquistas são permanentes e chegam como notificação:
Fora do diretório de pessoas, você não ganha as conquistas de ranking.
Com Permitir comentários de não-membros ligado, quem tem conta com e-mail verificado comenta nos cards. Um visitante sem login vê o convite para entrar. Quem não confirmou o e-mail vê o aviso para verificar.
Com Permitir sugestões de cards de não-membros ligado, quem é de fora vê o botão Propor card na visão geral e na página Contribuir, e Sugerir card no board e na lista de cards.
Com a triagem ligada, a proposta fica fora da board até alguém aceitar. Enquanto isso, ela não aparece no feed de atividade, não dispara webhooks e só é vista pelo autor e pelos mantenedores. Com a triagem desligada, entra direto na board.
Escreva numa página da wiki as regras do projeto: como propor, como trabalhar num card e o que esperar da revisão. Depois escolha a página em Configurações → Visibilidade → Guia de contribuição.
O guia aparece no topo da página Contribuir e antes do formulário de proposta. Sem guia, quem administra o projeto vê na página Contribuir o atalho Escolher guia.
Todo projeto público tem a seção Contribuir na barra lateral, em https://app.krakendock.com/HANDLE/KEY/contribute, aberta também a visitantes. Ela mostra:
Um card só aparece ali enquanto está aberto para contribuição, sem responsável, fora das colunas de concluídos e sem estar arquivado.
Para abrir um card a quem é de fora, edite o card e preencha:
Quem tem permissão de editar cards ou de fazer triagem marca esses campos.
Num card aberto para contribuição, quem é de fora vê Aberto para contribuição e o botão Quero trabalhar nisso.
Contributor na lista de acesso), que edita e move só os próprios cards.Regras:
A Triagem fica na barra lateral do projeto, com o número de propostas pendentes, para quem pode fazer triagem. Atalho: g e depois t. Ela tem três abas: Propostas, Denúncias e Pedidos.
Filtre por Pendentes, Aguardando informação ou Recusadas. As mais antigas aparecem primeiro. Use j e k para passar de uma proposta para outra.
| Ação | O que acontece |
|---|---|
| Aceitar | escolha a Board e a Coluna: a proposta vira um card comum do projeto |
| Pedir informações | sua Mensagem (Markdown, até 5.000 caracteres) vira um comentário no card, e a proposta passa a Aguardando informação |
| Recusar | escolha o Motivo: Não vamos fazer, Duplicata, Inválida ou Spam. Numa duplicata, indique o Card original |
O autor é avisado de cada decisão. Ele responde a um pedido de informações nos comentários do card, e a proposta continua em Aguardando informação até você aceitar ou recusar. Uma proposta recusada não entra na board e fica no filtro Recusadas. O autor continua vendo o card, com o motivo.
No menu do card, Recusar como spam faz o mesmo que recusar com o motivo Spam.
Filtre por Abertos, Aprovados, Recusados ou Expirados. Em cada pedido, use Aprovar ou Recusar. Na recusa, o Motivo (opcional) tem até 500 caracteres. Na página do card, os mantenedores também veem os pedidos daquele card.
Num projeto público, quem modera tem estas ferramentas.
No menu de um comentário:
No menu do card, Travar conversa impede quem não é membro de comentar. Destravar conversa desfaz. Os comentários e os cards de quem é de fora podem ser excluídos por quem tem a permissão de excluir cards.
Qualquer pessoa logada que vê o projeto, e não modera, pode denunciar um card (Denunciar card) ou um comentário, com um motivo e Detalhes (opcional). Quem foi denunciado não fica sabendo quem denunciou.
As denúncias ficam na aba Denúncias da Triagem, das mais antigas para as mais novas. Filtre por Abertas, Resolvidas, Dispensadas ou Todas e use Resolver, Dispensar ou Bloquear autor.
Um usuário bloqueado continua lendo o projeto, mas não comenta, não propõe cards, não denuncia e não pede cards. Os pedidos abertos dele são recusados na hora.
| Ação | Quem pode |
|---|---|
| Tornar público ou privado | o dono do projeto pessoal; numa organização, quem gerencia projetos (org:projects:manage) |
| Ligar comentários, propostas e triagem, escolher README e guia | quem gerencia o projeto (project:manage) |
| Marcar cards para contribuição | card:write ou card:triage |
| Usar a Triagem (propostas, pedidos e denúncias) e ocultar comentários | card:triage ou project:manage |
| Travar e destravar conversas | card:write ou card:triage |
| Bloquear e desbloquear usuários | project:manage |
| Excluir cards e comentários de outras pessoas | card:delete |
| Comentar, propor, pedir um card e denunciar sendo de fora | conta com e-mail verificado, sem bloqueio no projeto |
Os papéis de sistema do projeto, escolhidos em Configurações → Colaboradores e times:
| Papel | Para quem | O que faz |
|---|---|---|
Admin | mantenedores | tudo, inclusive card:triage |
Triage | quem ajuda a triar sem administrar | Triagem, denúncias e edição de cards. Não exclui cards, não mexe em membros, sprints, wiki nem configurações |
Contributor | quem teve um pedido aprovado | lê o projeto, comenta, propõe cards e edita ou move só os cards atribuídos a ele ou criados por ele |
Não. Qualquer pessoa lê um projeto público sem login. A conta, com e-mail verificado, só é necessária para comentar, propor, pedir um card, denunciar e dar estrela.
Confira, nesta ordem: se ela está logada e com o e-mail verificado; se Permitir comentários de não-membros está ligado; se a conversa do card está travada; e se ela está bloqueada em Configurações → Moderação.
Só o autor e quem pode fazer triagem. Para os outros, o card não existe até ser aceito.
O card saiu da lista porque ganhou um responsável, foi concluído ou arquivado, ou teve a Contribuição voltada para Nenhuma.
Num projeto de organização, o card só pode ser atribuído a membros da organização. Convide a pessoa para a organização antes de aprovar, ou recuse o pedido.
Confira se ele está Público. Os números do projeto no Explorar são atualizados a cada 5 minutos. Adicione Tópicos em Configurações → Geral para o projeto aparecer nas buscas por tema.
Confira se o seu e-mail está verificado e se Aparecer na busca de pessoas e em rankings está ligado no seu perfil. Só contam projetos públicos com outra pessoa contribuindo no mesmo período, e o ranking é atualizado a cada 15 minutos.
Sim. Importe as issues e mantenha os cards sincronizados com elas. Veja o guia do GitHub.