Note
Este artigo se aplica somente à publicação de aplicativos do GitHub Marketplace. Para obter mais informações mais sobre como publicar o GitHub Actions no GitHub Marketplace, confira "Publicar ações no GitHub Marketplace".
Os requisitos para a anunciar um aplicativo em GitHub Marketplace variam de acordo com o fato de você desejar oferecer um aplicativo grátis ou pago.
Requisitos para todos os anúncios de GitHub Marketplace
Todos os anúncios em GitHub Marketplace devem ser para ferramentas que fornecem valor à comunidade de GitHub Enterprise Cloud. Ao enviar sua listagem para publicação, leia e aceite os termos e condições do Contrato de desenvolvedor do GitHub Marketplace.
Requisitos de experiência do usuário para todos os aplicativos
Todos os anúncios devem atender aos requisitos a seguir, independentemente de serem para um aplicativo grátis ou pago.
- Os anúncios não devem persuadir ativamente os usuários para fora de GitHub Enterprise Cloud.
- Os anúncios devem incluir informações de contato válidas para o editor.
- Os anúncios devem ter uma descrição relevante do aplicativo.
- Os anúncios devem especificar um plano de preços.
- 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 em versão prévia pública ou disponíveis apenas por convite, com exceção do Copilot Extensions.
- Os aplicativos devem ter eventos webhook configurados para notificar o editor de qualquer alteração do plano ou cancelamentos usando a API de GitHub Marketplace Para saber mais, confira Usar a API do GitHub Marketplace no seu aplicativo.
Para saber mais sobre como fornecer uma boa experiência do cliente, confira Práticas recomendadas de experiência do cliente para aplicativos.
Requisitos da marca e anúncios para todos os aplicativos
- Os aplicativos que usam logotipos do GitHub precisam seguir as diretrizes de GitHub. Para obter mais informações, confira Logotipos e uso do GitHub.
- Os aplicativos devem ter um logotipo, cartão de recurso e imagens de capturas de tela que atendam às recomendações fornecidas em Escrever uma descrição da listagem para o seu aplicativo.
- As listagens devem incluir descrições bem escritas e sem erros gramaticais. Para obter diretrizes sobre como escrever sua listagem, confira Escrever uma descrição da listagem para o seu aplicativo.
Para proteger seus clientes, recomendamos que siga as práticas recomendadas em matéria de segurança. Para saber mais, confira Práticas recomendadas de segurança para aplicativos no GitHub Marketplace.
Considerações para aplicativos gratuitos
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.
Requisitos para GitHub Copilot Extensions
Copilot Extensions são essencialmente GitHub Apps com acesso de leitura adicional a Copilot Chat, integração com a API Copilot e integração opcional em outros LLMs.
Para publicar uma extensão, ela deve pertencer a uma conta da organização com status de Criador verificado. Para saber mais sobre o processo de verificação ou a transferência da propriedade do seu aplicativo, confira Candidatar-se à verificação de publicador para a sua organização.
Os requisitos para publicar um Copilot Extension são os mesmos que os requisitos para aplicativos gratuitos, com as seguintes exceções:
-
Sua extensão deve fornecer uma resposta clara e descritiva a um prompt como "O que você pode fazer?" ou "Liste suas capacidades".
-
Sua extensão pode estar em versão prévia pública, desde que isso seja claramente comunicado na descrição da listagem. Se você estiver usando uma lista de espera, deverá incluir também um link para criar conta na parte superior da descrição. Alguém da equipe de revisão do GitHub entrará na lista de espera e enviará um e-mail ao seu líder técnico solicitando acesso para teste.
-
Você deve incluir links para dois vídeos que demonstrem o seguinte:
- Alguns exemplos de prompts e respostas de sua extensão
- Um novo usuário da rede instalando, autenticando e enviando seu primeiro prompt para sua extensão
Esses vídeos são privados para o GitHub e são usados exclusivamente para revisar o envio do seu anúncio. Os vídeos podem ser brevesm, e você não precisa editá-los.
-
Sua extensão deve fornecer uma experiência de usuário estável e confiável e ser capaz de executar as capacidades listadas na descrição.
-
Você deve fornecer um caminho para que novos usuários instalem, configurem e autorizem sua extensão com o mínimo de atrito. Se a equipe de revisão do GitHub não conseguir testar com êxito a sua extensão, ela não será aprovada para publicação.
Requisitos para aplicativos pagos
Para publicar um plano pago para o seu aplicativo no GitHub Marketplace, seu aplicativo deverá pertencer a uma organização que seja um fornecedor verificado. Para saber mais sobre o processo de verificação ou a transferência da propriedade do seu aplicativo, confira Candidatar-se à verificação de publicador para a sua organização.
Se seu aplicativo já está publicado e você é um editor verificado, você poderá publicar um novo plano pago no editor do plano de preços. Para saber mais, confira Definir planos de cobrança para sua listagem.
Para publicar um aplicativo pago (ou um aplicativo que ofereça um plano pago), você também deve atender aos seguintes requisitos:
- GitHub Apps deve ter no mínimo 100 instalações.
- OAuth apps deve ter no mínimo 200 usuários.
- Todos os aplicativos pagos devem lidar com eventos de compra de GitHub Marketplace para novas compras, atualizações, downgrades, cancelamentos e testes grátis. Para obter mais informações, confira Requisitos de cobrança para aplicativos pagos abaixo.
Quando estiver pronto para publicar o aplicativo em GitHub Marketplace, você deverá solicitar a verificação para o anúncio do aplicativo.
Note
Se você desejar vender um aplicativo que pertence à sua conta pessoal, primeiro você deverá transferir o aplicativo para uma organização e, em seguida, solicitar a verificação para um anúncio criado pela organização. Para obter mais informações sobre como transferir um aplicativo para uma organização, confira: Enviando seu anúncio para publicação.
Requisitos de cobrança para aplicativos pagos
Seu aplicativo não precisa gerenciar pagamentos, mas precisa usar eventos de compra de GitHub Marketplace para gerenciar novas compras, atualizações, downgrades, cancelamentos e testes grátis. Para obter informações sobre como integrar esses eventos em seu aplicativo, confira Usar a API do GitHub Marketplace no seu aplicativo.
Usar a API de cobrança do GitHub permite que os clientes comprem um aplicativo sem sair do GitHub e pagar pelo serviço com o método de pagamento já anexado à sua conta no 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 saber mais, confira Definir planos de cobrança para sua listagem.