Esta folha de dicas resume os passos importantes a seguir para promover um projeto de código aberto nas melhores condições. É possível exibir informações adicionais para um item da lista clicando nele.
Idiomas disponíveis :
- العربية
- English
- Català
- Deutsch
- Español
- پارسی
- Français
- Bahasa Indonesia
- Italiano
- 日本語
- Português
- Русский
- සිංහල
- Türkçe
- 简体中文
- 繁體中文
Falta um idioma? Você acha que é possível melhorar esta folha de dicas? Contribuições são bem-vindas !
👌 Verifique se o projeto está suficientemente maduro
Certifique-se de que o seu projecto é estável e tem um mínimo de características interessantes para envolver os visitantes.
😎 Escolha um nome fixe para o seu projeto
Escolha um nome que seus visitantes se lembrem facilmente.
💅 Cuide da apresentação do README
O README é a primeira coisa que os visitantes vêem na página do seu projeto. Trabalhe na apresentação para torná-la simples, bonita e agradável de ler. Você encontrará exemplos de README tratados aqui.
💪 Destacar os pontos fortes do projeto
Identificar os pontos fortes de seu projeto e colocá-los para a frente de modo que é a primeira coisa que seus visitantes vejam.
✨ Apresentar uma demonstração do projeto
Seus visitantes vão querer entender rapidamente quais são as necessidades do seu projeto e como ele funciona. Fornecer uma demonstração é uma ótima maneira de satisfazer seus visitantes. O formato da demonstração pode ser:
- um GIF animado
- um link para uma demonstração online
👌 A instalação e o uso do projeto devem ser o mais simples possível
Você pode perder visitantes se o projeto não for fácil de instalar ou usar.
📘 Crie uma documentação clara e estruturada
Criar boa documentação é provavelmente o passo mais importante. Se sua documentação não for longa, você poderá incluí-la diretamente no seu README. Se for volumoso, o melhor será hospedá-lo em um site diferente. Alguns projetos de código aberto como o vuepress podem criar rapidamente uma boa documentação.
⭐ Confiar futuros visitantes antes de publicar nas redes sociais
A maioria dos visitantes olhará para o número de estrelas no projeto antes de usá-lo. Quanto mais estrelas o seu projecto tiver, maior será o seu índice de fiabilidade. Não hesite em pedir a seus parentes, colegas e amigos para ajudá-lo a melhorar a credibilidade do seu projeto adicionando uma estrela.
↗️ Compartilhar o projeto em redes sociais e plataformas especializadas
Aqui estão algumas plataformas nas quais você pode compartilhar seu trabalho :
📃 Escreva artigos mencionando o projeto
Escreva artigos e cite seu projeto. O assunto do artigo pode estar relacionado com a pilha técnica que utilizou, os problemas que encontrou, etc. Postar nas plataformas de publicação:
🎤 Apresentar o projeto em conferências / encontros
Apresentar seu projeto em conferências e encontros é uma ótima maneira de melhorar sua visibilidade.
🎥 Gravar e publicar vídeos de apresentação do projeto
Gravar um vídeo não é um exercício fácil, mas é uma das maneiras mais eficazes de tornar seu projeto popular.
🕐 Escolha o melhor momento para publicar nas redes sociais
Normalmente, a melhor altura para iniciar uma comunicação é no meio da semana. Não comunicar durante os períodos de férias ou fins de semana.
🗑 Não faça spam nas plataformas com promoção do projeto
Não publique duas vezes na mesma plataforma. Sua comunicação pode ser considerada spam e causar má publicidade para o seu projeto.
🆕 Atualizar regularmente o projeto
Mantenha e melhore seu projeto publicando novas versões. Não se esqueça de produzir os changelogs associados.
❗ Manter o projeto e tratar de problemas abertos.
Não deixe problemas sem resposta. Seja cortês e simpático com as pessoas que tiveram tempo para abrir sugestões. 😉
🙏 Convidar os utilizadores a contribuir
Um projeto saudável é um projeto que tem uma comunidade e colaboradores. Mostre aos seus utilizadores que sua ajuda é bem-vinda marcando alguns problemas com as etiquetas
contribution welcomeougood first issue. Pode encontrar mais informações nas etiquetas clicando aqui.
🏆 Recompensar os contribuidores
Alguns projetos open-source como o gatsby recompensam seus colaboradores com goodies. Se você não puder pagar, faça uma publicação (no twitter ou em outras plataformas) que mencione a contribuição e seu autor para agradecê-lo (ex: Post no twitter). Você também pode abrir uma seção
Contributorsno seu README para mostrar publicamente seus agradecimentos a seus colaboradores ou destacá-los em seu website ou documentação do projeto.
💬 Abra um chat para a comunidade do projeto
Os issues do Github nem sempre são a melhor maneira de se comunicar com seus utilizadores. Se necessário, você pode abrir um chat para conversar com eles :
🔙 Pedir feedback dos utilizadores
O feedback dos utilizadores é uma excelente forma de melhorar o seu projecto. Seus utilizadores provavelmente têm muitas idéias que poderiam melhorar o seu projeto.
❤️ Mostrar o que outros utilizadores criaram com o seu projecto
Os visitantes confiarão mais facilmente se virem casos concretos de uso (ex. : vuepress gallery).
Esteja à vontade para colocar uma ⭐ se este projecto o ajudar.
Obrigado a todos os ótimos colaboradores:
Este projecto segue as especificações all-contributors. Contribuições de qualquer tipo são bem-vindas!