Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Requisitos para listar um aplicativo

Os aplicativos no GitHub Marketplace devem atender aos requisitos definidos nesta página antes que nossos especialistas de integração do GitHub Marketplace aprovem a listagem.

Neste artigo

Antes de enviar seu aplicativo para revisão, você deve ler e aceitar os termos do "GitHub Marketplace Contrato do Desenvolvedor". Você aceitará os termos dentro do seu rascunho de listagem em GitHub. Assim que enviar o seu aplicativo, um dos especialistas de integração de GitHub Marketplace entrará em contato com mais informações sobre o processo de integração e irá revisar o seu aplicativo para garantir que atende a estes requisitos:

Experiência do usuário

  • Os aplicativo GitHubs deve ter, no mínimo, 100 instalações.

  • Os aplicativo OAuths devem ter, no mínimo, 200 usuários.

  • Os aplicativos devem fornecer valor aos clientes e integrar-se à plataforma de alguma forma além da autenticação.

  • Os aplicativos devem estar disponíveis publicamente em GitHub Marketplace e não podem estar na versão beta ou disponíveis apenas por convite.

  • Os aplicativos não podem persuadir ativamente os usuários ativamente para sair do GitHub.

  • Os materiais de marketing do aplicativo devem representar com precisão o comportamento do aplicativo.

  • Os aplicativos devem incluir links para a documentação do usuário que descreve como configurá-lo e usá-lo.

  • Quando um cliente compra um aplicativo e o GitHub o redireciona para o URL de instalação do aplicativo, o aplicativo deverá iniciar o fluxo do OAuth imediatamente. Para obter mais informações, consulte "Gerenciando novas compras e testes grátis".

  • Os clientes devem ser capazes de instalar seu app e selecionar repositórios em uma conta pessoal e de organização. Eles devem ser capazes de visualizar e gerenciar essas contas separadamente.

Marca e listagem

Segurança

Os aplicativos passarão por uma revisão de segurança antes de serem listados em GitHub Marketplace. Uma revisão bem-sucedida atenderá aos requisitos e seguirá as práticas recomendadas de segurança listadas noprocesso de revisão de segurança". Para obter informações sobre o processo de revisão, entre em contato com marketplace@github.com.

Fluxos de cobrança

Seu aplicativo deve integrar-se aos os fluxos de cobrança, usando o evento de webhook de GitHub Marketplace.

Aplicativos grátis

Aplicativos gratuitos são incentivados em GitHub Marketplace e são uma ótima maneira de oferecer serviços de código aberto. Se você listar uma versão paga do seu aplicativo fora do GitHub Marketplace, você deve oferecer pelo menos um plano pago ao listar o aplicativo em GitHub Marketplace. Se você estiver listando um aplicativo grátis, você deverá atender a estes requisitos:

  • Os clientes devem ser capazes de ver que eles têm um plano grátis seção de cobrança, perfil ou configurações de conta do aplicativo.
  • Quando um cliente cancelar seu aplicativo, você deverá seguir o fluxo para cancelar planos.

Para oferecer seu aplicativo como um serviço pago, você precisará atender a estes requisitos para listar seu aplicativo em GitHub Marketplace:

  • Para vender seu aplicativo em GitHub Marketplace, ele deverá usar o sistema de cobrança do GitHub. Seu aplicativo não precisa gerenciar pagamentos, mas deve usar " eventos de compra de GitHub Marketplace para gerenciar novas compras, atualizações, downgrades, cancelamentos e testes grátis. Consulte "Fluxos de cobrançapara saber mais sobre como integrar esses eventos ao seu aplicativo. Usar o sistema de cobrança do GitHub permite aos clientes comprar um aplicativo sem sair do GitHub e pagar pelo serviço com o método de pagamento já anexado à sua conta GitHub.
  • Os aplicativos devem ser compatíveis tanto com a cobrança anual quanto mensal para as compras de suas assinaturas pagas.
  • As listagens podem oferecer qualquer combinação de planos grátis e pagos. Os planos grátis são opcionais, porém incentivados. Para obter mais informações, consulte "Definir um plano de preços da listagem do GitHub Marketplace".
  • Os clientes que cancelarem um plano pago comprado em GitHub Marketplace devem ser automaticamente rebaixados para o plano gratuito do aplicativo, se ele existir. Quando um cliente cancela uma assinatura do GitHub Marketplace, o GitHub não desinstala automaticamente o aplicativo, então o cliente pode esperar que os recursos gratuitos continuem funcionando. é altamente recomendável permitir que os clientes reativem seu plano anterior.
  • Os clientes devem ser capazes de atualizar a partir da interface de usuário do seu aplicativo, se você fornecer um upgrade URL neste formato: https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
  • Os clientes devem ser capazes de modificar quais usuários têm acesso ao seu aplicativo a partir do site do seu aplicativo, caso tenham comprado assentos (por plano de preços unitários) ou que o plano ofereça colaboradores ilimitados.
  • Os clientes devem poder ver as seguintes alterações em sua conta imediatamente na faturação, perfil ou seção de configurações de conta do site:
    • Plano e preço atuais.
    • Novos planos comprados.
    • Upgrades, downgrades, cancelamentos e o número de dias restantes em uma avaliação gratuita.
    • Alterações nos ciclos de faturamento (mensal ou anual).
    • Uso e recursos restantes para planos fixos e por unidade. Por exemplo, se o plano de preços é por unidade, o site do aplicativo deve mostrar unidades usadas e unidades disponíveis.

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato