288 lines
12 KiB
Markdown
288 lines
12 KiB
Markdown
<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>
|
|
|
|
> 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](./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) !
|
|
|
|
## 1. 🎢 Preparação
|
|
|
|
<br />
|
|
|
|
<details>
|
|
<summary>👌 Verifique se o projeto está maduro o suficiente</summary>
|
|
<p>
|
|
|
|
> Certifique-se de que o seu projecto é estável e tem um mínimo de características interessantes para envolver os visitantes.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>😎 Escolha um nome legal para o seu projeto</summary>
|
|
<p>
|
|
|
|
> Escolha um nome que seus visitantes possam facilmente lembrar.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>💅 Cuide da apresentação do README</summary>
|
|
<p>
|
|
|
|
> 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)
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>💪 Destacar os pontos fortes do projeto</summary>
|
|
<p>
|
|
|
|
> Identificar os pontos fortes de seu projeto e colocá-los para a frente de modo que é a primeira coisa que seus visitantes vejam.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>✨ Apresentar uma demonstração do projeto</summary>
|
|
<p>
|
|
|
|
> 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
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>👌 A instalação e o uso do projeto devem ser o mais simples possível</summary>
|
|
<p>
|
|
|
|
> Você pode perder visitantes se o projeto não for fácil de instalar ou usar.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>📘 Crie uma documentação clara e estruturada</summary>
|
|
<p>
|
|
|
|
> 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.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<br />
|
|
|
|
## 2. 📢 Comunicar o projeto
|
|
|
|
<br />
|
|
|
|
<details>
|
|
<summary>⭐ Confiar futuros visitantes antes de publicar nas redes sociais</summary>
|
|
<p>
|
|
|
|
> 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.
|
|
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>↗️ Compartilhar o projeto em redes sociais e plataformas especializadas</summary>
|
|
<p>
|
|
|
|
> Aqui estão algumas plataformas nas quais você pode compartilhar seu trabalho :
|
|
>
|
|
> - [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>
|
|
<summary>📃 Escreva artigos mencionando o projeto</summary>
|
|
<p>
|
|
|
|
> 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:
|
|
>
|
|
> - [medium](https://medium.com/)
|
|
> - [dev.to](https://dev.to/)
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🎤 Apresentar o projeto em conferências / encontros</summary>
|
|
<p>
|
|
|
|
> Apresentar seu projeto em conferências e encontros é uma ótima maneira de melhorar sua visibilidade.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🎥 Gravar e publicar vídeos de apresentação do projeto</summary>
|
|
<p>
|
|
|
|
> Gravar um vídeo não é um exercício fácil, mas é uma das maneiras mais eficazes de tornar seu projeto popular.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🕐 Escolha o melhor momento para publicar nas redes sociais</summary>
|
|
<p>
|
|
|
|
> 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.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🗑 Não faça spam nas plataformas com promoção do projeto</summary>
|
|
<p>
|
|
|
|
> Não publique duas vezes na mesma plataforma. Sua comunicação pode ser considerada spam e causar má publicidade para o seu projeto.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<br />
|
|
|
|
## 3. 🤝 Garder les utilisateurs
|
|
|
|
<br />
|
|
|
|
<details>
|
|
<summary>🆕 Mettre régulièrement à jour le projet</summary>
|
|
<p>
|
|
|
|
> Maintenez et améliorez votre projet en publiant de nouvelles versions. N'oubliez pas de générer les changelogs associés.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>❗ Maintenir le projet et traiter les issues ouvertes</summary>
|
|
<p>
|
|
|
|
> Ne laissez pas les issues sans réponse. Soyez courtois et sympathique avec les personnes qui ont pris le temps d'ouvrir des issues. 😉
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🙏 Inviter les utilisateurs à contribuer</summary>
|
|
<p>
|
|
|
|
> Un projet en bonne santé est un projet qui possède une communauté et des contributeurs. Montrez à vos utilisateurs que leur aide est la bienvenue en taggant certaines issues avec les labels `contribution welcome` ou `good first issue`. [Vous trouverez plus d'information sur les labels en cliquant ici.](https://help.github.com/en/articles/about-labels)
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🏆 Récompenser les contributeurs</summary>
|
|
<p>
|
|
|
|
> Certains projets open-source comme [gatsby](https://github.com/gatsbyjs/gatsby) récompensent leurs contributeurs avec des goodies. Si vous n'en n'avez pas les moyens, faites une publication (sur twitter ou d'autres plateformes) qui mentionne la contribution et son auteur afin de le remercier (ex. : [Post sur twitter](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Vous pouvez aussi ouvrir une section `Contributors` sur votre README afin d'afficher publiquement votre gratitude envers vos contributeurs ou encore les mettre en avant sur le site ou la documentation de votre projet.
|
|
>
|
|
> - [vuepress (section contributeurs dans le README)](https://github.com/vuejs/vuepress#code-contributors)
|
|
> - [Rythm.js (Mise en avant de manière aléatoire d'un contributeur sur la page de démo)](https://okazari.github.io/Rythm.js/)
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>💬 Ouvrir un chat pour la communauté du projet</summary>
|
|
<p>
|
|
|
|
> Les issues Github ne sont pas toujours la meilleure manière de communiquer avec vos utilisateurs. Si nécessaire, vous pouvez ouvrir un chat pour discuter avec eux :
|
|
>
|
|
> - [Discord](https://discordapp.com)
|
|
> - [Slack](https://slack.com)
|
|
> - [Gitter](https://gitter.im/)
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>🔙 Demander des retours utilisateurs</summary>
|
|
<p>
|
|
|
|
> Les retours des utilisateurs sont un excellent moyen d'améliorer votre projet. Vos utilisateurs ont probablement un tas d'idées qui pourraient rendre votre projet meilleur.
|
|
</p>
|
|
|
|
<br />
|
|
</details>
|
|
|
|
<details>
|
|
<summary>❤️ Montrer ce que les autres utilisateurs ont créé avec votre projet</summary>
|
|
<p>
|
|
|
|
> Les visiteurs accorderont plus facilement leur confiance s'ils voient des cas concrets d'utilisation (ex. : [vuepress gallery](https://vuepress.gallery/)).
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<br />
|
|
|
|
## 🙏 Montrez votre support
|
|
|
|
N'hésitez pas à mettre une ⭐ si ce projet vous a aidé.
|
|
|
|
## ❤️ Contributeurs
|
|
|
|
Merci à tous les formidables contributeurs:
|
|
|
|
<!-- 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 -->
|
|
|
|
Ce projet suit la spécification [all-contributors](https://github.com/all-contributors/all-contributors). Les contributions de tout type sont les bienvenues !
|