2019-10-16 21:10:37 +02:00
< p align = "center" >
< img alt = "oss image" src = "./imgs/zoss-logo.svg" height = "200px" width = "200px" >
< / p >
< p align = "center" >
< a href = "https://twitter.com/intent/tweet?text=How%20to%20promote%20your%20open-source%20projects%20@ZenikaOSS&url=https://github.com/zenika-open-source/open-source-promotion-cheat-sheet&hashtags=OpenSource,CheatSheet" >
< img alt = "tweet" src = "https://img.shields.io/twitter/url/https/twitter?label=Share%20on%20twitter&style=social" target = "_blank" / >
< / a >
< / p >
< h1 align = "center" > Folha de dicas : Promover um projeto de código aberto< / h1 >
2019-10-16 21:40:20 +02:00
> 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.
2019-10-16 21:10:37 +02:00
Idiomas disponíveis :
- [English ](./README.md )
- [Français ](./README-fr.md )
- [Deutsch ](./README-de.md )
- [Português ](./README-pt.md )
Falta um idioma? Você acha que é possível melhorar esta folha de dicas? [Contribuições são bem-vindas ](./CONTRIBUTING.md ) !
2019-10-16 21:40:20 +02:00
## 1. 🎢 Preparação
2019-10-16 21:10:37 +02:00
< br / >
< details >
2019-10-18 20:42:45 +02:00
< summary > 👌 Verifique se o projeto está suficientemente maduro< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-16 21:40:20 +02:00
> Certifique-se de que o seu projecto é estável e tem um mínimo de características interessantes para envolver os visitantes.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:42:45 +02:00
< summary > 😎 Escolha um nome fixe para o seu projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:42:45 +02:00
> Escolha um nome que seus visitantes se lembrem facilmente.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-16 21:40:20 +02:00
< summary > 💅 Cuide da apresentação do README< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-16 21:40:20 +02:00
> 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.](https://github.com/matiassingers/awesome-readme)
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-16 21:40:20 +02:00
< summary > 💪 Destacar os pontos fortes do projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-16 21:40:20 +02:00
> Identificar os pontos fortes de seu projeto e colocá-los para a frente de modo que é a primeira coisa que seus visitantes vejam.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-16 21:40:20 +02:00
< summary > ✨ Apresentar uma demonstração do projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-16 21:40:20 +02:00
> 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:
2019-10-16 21:10:37 +02:00
>
2019-10-16 21:40:20 +02:00
> - um GIF animado
> - um link para uma demonstração online
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-16 21:40:20 +02:00
< summary > 👌 A instalação e o uso do projeto devem ser o mais simples possível< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-16 21:40:20 +02:00
> Você pode perder visitantes se o projeto não for fácil de instalar ou usar.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-16 21:40:20 +02:00
< summary > 📘 Crie uma documentação clara e estruturada< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-16 21:40:20 +02:00
> 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](https://v1.vuepress.vuejs.org) podem criar rapidamente uma boa documentação.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< br / >
2019-10-18 20:09:26 +02:00
## 2. 📢 Comunicar o projeto
2019-10-16 21:10:37 +02:00
< br / >
< details >
2019-10-18 20:09:26 +02:00
< summary > ⭐ Confiar futuros visitantes antes de publicar nas redes sociais< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> 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.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:09:26 +02:00
< summary > ↗️ Compartilhar o projeto em redes sociais e plataformas especializadas< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> Aqui estão algumas plataformas nas quais você pode compartilhar seu trabalho :
2019-10-16 21:10:37 +02:00
>
> - [Twitter](https://twitter.com)
> - [Linkedin](https://www.linkedin.com/)
> - [Facebook](https://www.facebook.com/)
> - [Reddit](https://www.reddit.com/)
> - [Dev.to](https://dev.to/)
> - [Lobsters](https://lobste.rs/)
> - [Hacker News](https://news.ycombinator.com/)
> - [Product Hunt](https://www.producthunt.com/)
> - [Beta page](https://betapage.co/)
> - [Human Coders](https://news.humancoders.com/)
< / p >
< / details >
< details >
2019-10-18 20:09:26 +02:00
< summary > 📃 Escreva artigos mencionando o projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> 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:
2019-10-16 21:10:37 +02:00
>
> - [medium](https://medium.com/)
> - [dev.to](https://dev.to/)
< / p >
< / details >
< details >
2019-10-18 20:09:26 +02:00
< summary > 🎤 Apresentar o projeto em conferências / encontros< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> Apresentar seu projeto em conferências e encontros é uma ótima maneira de melhorar sua visibilidade.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:09:26 +02:00
< summary > 🎥 Gravar e publicar vídeos de apresentação do projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> Gravar um vídeo não é um exercício fácil, mas é uma das maneiras mais eficazes de tornar seu projeto popular.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:09:26 +02:00
< summary > 🕐 Escolha o melhor momento para publicar nas redes sociais< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> 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.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:09:26 +02:00
< summary > 🗑 Não faça spam nas plataformas com promoção do projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:09:26 +02:00
> Não publique duas vezes na mesma plataforma. Sua comunicação pode ser considerada spam e causar má publicidade para o seu projeto.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< br / >
2019-10-18 20:31:54 +02:00
## 3. 🤝 Manter os utilizadores
2019-10-16 21:10:37 +02:00
< br / >
< details >
2019-10-18 20:31:54 +02:00
< summary > 🆕 Atualizar regularmente o projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:31:54 +02:00
> Mantenha e melhore seu projeto publicando novas versões. Não se esqueça de produzir os changelogs associados.
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:31:54 +02:00
< summary > ❗ Manter o projeto e tratar de problemas abertos.< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:31:54 +02:00
> Não deixe problemas sem resposta. Seja cortês e simpático com as pessoas que tiveram tempo para abrir sugestões. 😉
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:31:54 +02:00
< summary > 🙏 Convidar os utilizadores a contribuir< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:42:45 +02:00
> 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 welcome` ou ` good first issue`. [Pode encontrar mais informações nas etiquetas clicando aqui.](https://help.github.com/en/articles/about-labels)
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:31:54 +02:00
< summary > 🏆 Recompensar os contribuidores< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:31:54 +02:00
> Alguns projetos open-source como o [gatsby](https://github.com/gatsbyjs/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](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Você também pode abrir uma seção `Contributors` no seu README para mostrar publicamente seus agradecimentos a seus colaboradores ou destacá-los em seu website ou documentação do projeto.
2019-10-16 21:10:37 +02:00
>
2019-10-18 20:31:54 +02:00
> - [vuepress (seção de contribuidores no README)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (Destacando de maneira aleatória um colaborador na página de demonstração)](https://okazari.github.io/Rythm.js/)
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< details >
2019-10-18 20:31:54 +02:00
< summary > 💬 Abra um chat para a comunidade do projeto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:31:54 +02:00
> 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 :
2019-10-16 21:10:37 +02:00
>
> - [Discord](https://discordapp.com)
> - [Slack](https://slack.com)
> - [Gitter](https://gitter.im/)
< / p >
< / details >
< details >
2019-10-18 20:31:54 +02:00
< summary > 🔙 Pedir feedback dos utilizadores< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:31:54 +02:00
> 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.
2019-10-16 21:10:37 +02:00
< / p >
< br / >
< / details >
< details >
2019-10-18 20:31:54 +02:00
< summary > ❤️ Mostrar o que outros utilizadores criaram com o seu projecto< / summary >
2019-10-16 21:10:37 +02:00
< p >
2019-10-18 20:31:54 +02:00
> Os visitantes confiarão mais facilmente se virem casos concretos de uso (ex. : [vuepress gallery](https://vuepress.gallery/)).
2019-10-16 21:10:37 +02:00
< / p >
< / details >
< br / >
2019-10-18 20:31:54 +02:00
## 🙏 Mostre o seu apoio
2019-10-16 21:10:37 +02:00
2019-10-18 20:31:54 +02:00
Esteja à vontade para colocar uma ⭐ se este projecto o ajudar.
2019-10-16 21:10:37 +02:00
2019-10-18 20:31:54 +02:00
## ❤️ Contribuidores
2019-10-16 21:10:37 +02:00
2019-10-18 20:31:54 +02:00
Obrigado a todos os ótimos colaboradores:
2019-10-16 21:10:37 +02:00
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore -->
< table >
< tr >
< td align = "center" > < a href = "https://www.franck-abgrall.me/" > < img src = "https://avatars3.githubusercontent.com/u/9840435?v=4" width = "100px;" alt = "Franck Abgrall" / > < br / > < sub > < b > Franck Abgrall< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=kefranabg" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/tbetous" > < img src = "https://avatars3.githubusercontent.com/u/4435536?v=4" width = "100px;" alt = "Thomas Betous" / > < br / > < sub > < b > Thomas Betous< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=tbetous" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/ebriand" > < img src = "https://avatars1.githubusercontent.com/u/1011902?v=4" width = "100px;" alt = "Eric Briand" / > < br / > < sub > < b > Eric Briand< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=ebriand" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/FofoDev" > < img src = "https://avatars0.githubusercontent.com/u/27639429?v=4" width = "100px;" alt = "Faustine Godbillot" / > < br / > < sub > < b > Faustine Godbillot< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=FofoDev" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://myvirtualstorybook.com/" > < img src = "https://avatars1.githubusercontent.com/u/5747538?v=4" width = "100px;" alt = "Benjamin Plouzennec" / > < br / > < sub > < b > Benjamin Plouzennec< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=Okazari" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/Zenigata" > < img src = "https://avatars1.githubusercontent.com/u/1022393?v=4" width = "100px;" alt = "Johan Bonneau" / > < br / > < sub > < b > Johan Bonneau< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=Zenigata" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/bpetetot" > < img src = "https://avatars3.githubusercontent.com/u/516360?v=4" width = "100px;" alt = "Benjamin Petetot" / > < br / > < sub > < b > Benjamin Petetot< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=bpetetot" title = "Documentation" > 📖< / a > < / td >
< / tr >
< tr >
< td align = "center" > < a href = "https://nick-hat-boecker.de" > < img src = "https://avatars0.githubusercontent.com/u/8366071?v=4" width = "100px;" alt = "NickHatBoecker" / > < br / > < sub > < b > NickHatBoecker< / b > < / sub > < / a > < br / > < a href = "#translation-NickHatBoecker" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://github.com/Claire" > < img src = "https://avatars2.githubusercontent.com/u/5114096?v=4" width = "100px;" alt = "Claire Martinez" / > < br / > < sub > < b > Claire Martinez< / b > < / sub > < / a > < br / > < a href = "#translation-claire" title = "Translation" > 🌍< / a > < / td >
< td align = "center" > < a href = "https://hazeforum.com/" > < img src = "https://avatars2.githubusercontent.com/u/31011359?v=4" width = "100px;" alt = "André Gama" / > < br / > < sub > < b > André Gama< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=andregamma" title = "Documentation" > 📖< / a > < / td >
< td align = "center" > < a href = "https://github.com/mbernardeau" > < img src = "https://avatars0.githubusercontent.com/u/7049049?v=4" width = "100px;" alt = "Mathias Bernardeau" / > < br / > < sub > < b > Mathias Bernardeau< / b > < / sub > < / a > < br / > < a href = "https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=mbernardeau" title = "Documentation" > 📖< / a > < / td >
< / tr >
< / table >
<!-- ALL - CONTRIBUTORS - LIST:END -->
2019-10-18 20:31:54 +02:00
Este projecto segue as especificações [all-contributors ](https://github.com/all-contributors/all-contributors ). Contribuições de qualquer tipo são bem-vindas!