295 lines
13 KiB
Markdown
295 lines
13 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=%E5%88%86%E4%BA%AB%E5%88%B0twitter&style=social" target="_blank" />
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">开源项目推广备忘单</h1>
|
||
|
||
> 这篇备忘单为您总结了一些关于如何最好地推广您的开源项目的重要步骤，您可以点击并展开下列选项以了解更多详情。
|
||
|
||
现已支持以下语言：
|
||
|
||
- [English](./README.md)
|
||
- [Français](./README-fr.md)
|
||
- [Deutsch](./README-de.md)
|
||
- [Español](./README-es.md)
|
||
- [简体中文](./README-zh-cn.md)
|
||
- [繁體中文](./README-zh-tw.md)
|
||
|
||
没有您需要的语言？希望帮忙改进这份备忘单？[欢迎您的贡献](./CONTRIBUTING.md)！
|
||
|
||
[我们也提供这份备忘单的 PDF 版本](./pdf/cheat-sheet.pdf)
|
||
|
||
## 1. 🎢 准备阶段
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>👌 保证您的项目已经足够成熟</summary>
|
||
<p>
|
||
|
||
> 您的项目必须足够稳定，并且拥有一些最低可行功能用以吸引用户们。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>😎 为您的项目挑选一个炫酷的名字</summary>
|
||
<p>
|
||
|
||
> 挑选一个用户们能轻易记住的名字。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💅 把您的README文档写得干净漂亮</summary>
|
||
<p>
|
||
|
||
> 您的访客们的第一件事就是阅读您的 README 文档，所以您得确保它干净漂亮、易于阅读。[这些优秀的 README 文档可以为您提供参考](https://github.com/matiassingers/awesome-readme)。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💪 强调您的项目中最闪耀的亮点</summary>
|
||
<p>
|
||
|
||
> 找出您的项目的强大之处并确保您的访客们在第一时间了解到它们。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>✨ 提供一个您项目的演示或示例</summary>
|
||
<p>
|
||
|
||
> 访客们通常希望迅速了解您的项目的目标，它的工作原理以及应该如何使用它。为您的项目提供一个演示或者示例可以很好地满足访客们的需求，比如说：
|
||
>
|
||
> - 利用 GIF 动画来展示您项目的工作原理
|
||
> - 提供一个在线演示的网页连接
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>👌 安装和使用必须超级简单</summary>
|
||
<p>
|
||
|
||
> 您的项目不够用户友好可能会造成访客们的流失。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>📘 创建一个干净整洁的结构化文档</summary>
|
||
<p>
|
||
|
||
> 一个优秀的文档也许是最为重要的一步了。如果您的文档比较小的话，您可以直接将它包含在 README 文档里。否则的话，您或许应该将您的文档托管在一个独立的网站上面。一些开源项目比如 [vuepress](https://v1.vuepress.vuejs.org) 可以帮助您非常容易地创建干净整洁的文档。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|
||
|
||
## 2. 📢 宣传您的辛苦工作
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>⭐ 在社交网络上发布您的项目之前，保证它是可以信赖的</summary>
|
||
<p>
|
||
|
||
> 许多访客会在考虑使用项目之前，先查看项目获得过得 star 数量。只需要一些 star 就能让您的项目比没有任何 star 的项目更加值得信赖，这就是为什么您应该在社交网络上公开宣布之前，请您认识的人支持您的项目。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>↗️ 在社交媒体和专业平台上分享您的项目</summary>
|
||
<p>
|
||
|
||
> 向世界展示您无与伦比的作品！您可以在以下社交媒体和专业平台上发布：
|
||
>
|
||
> - [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>📃 写一些文章并且提及您的项目</summary>
|
||
<p>
|
||
|
||
> 为您的项目写一些关于您项目的文章。您可以在其中分享您使用到的技术栈、您项目的工作原理和您遇到过得问题等等。然后把这些文章发布在这些平台上：
|
||
>
|
||
> - [medium](https://medium.com/)
|
||
> - [dev.to](https://dev.to/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🎤 在正式会议或线下聚会上介绍您的项目</summary>
|
||
<p>
|
||
|
||
> 在正式会议或线下聚会上介绍您的项目是提高知名度的好办法。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🎥 记录并发布项目介绍和原理解释等的视频</summary>
|
||
<p>
|
||
|
||
> 虽然录制视频并不轻松，但它也许是能让您的项目出名的最有效的办法。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🕐 选择最好的时间在社交媒体上发布</summary>
|
||
<p>
|
||
|
||
> 不要在假期或者周末发布您的项目。通常最适合在社交网络上发布的时间是一周里中间的那几天。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🗑 不要在平台上过度宣传</summary>
|
||
<p>
|
||
|
||
> 不要在相同的平台上发布两次。这将会被视为过度的宣传，并且有可能为您的项目招致负面宣传。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|
||
|
||
## 3. 🤝 留住您的用户们
|
||
|
||
<br />
|
||
|
||
<details>
|
||
<summary>🆕 尽量为您的项目定期发布新版本</summary>
|
||
<p>
|
||
|
||
> 维护并且改进您的项目，比如：新版本的发布和撰写变更记录。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>❗ 维护您的项目并处理未解决的issue</summary>
|
||
<p>
|
||
|
||
> 别让 issue 一直处于未解决的状态并且对此毫无回应。对那些花费自己时间提交 issue 的用户们好一点。 😉
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🙏 邀请用户们为项目贡献</summary>
|
||
<p>
|
||
|
||
> 一个健康的项目通常拥有一个社区和许多贡献者们。在一些 issue 上标注`contribution welcome`标签或者`good first issue`标签来让您的用户们知道您需要帮助。[关于 github 标签](https://help.github.com/en/articles/about-labels)。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🏆 奖励贡献者们</summary>
|
||
<p>
|
||
|
||
> 为那些帮助过您的人们鼓掌喝彩! 一些开源项目像是[gatsby](https://github.com/gatsbyjs/gatsby)会奖励贡献者们一些小礼物。如果您负担不起，也可以在 twitter 或者其它平台上发布一封关于项目贡献的公开感谢信，并且提及那些贡献者们（[公开感谢信的示例](https://twitter.com/FranckAbgrall/status/1139470547492978688)）。在您的 README 文档里开设一个`贡献者`栏，以此公开地感谢贡献者们。或者您也可以在项目文档或网站上展示您的贡献者们。以下是一些示例：
|
||
>
|
||
> - [vuepress （在 README 中的贡献者栏）](https://github.com/vuejs/vuepress#code-contributors)
|
||
> - [Rythm.js （在展示页面上随机显示贡献者）](https://okazari.github.io/Rythm.js/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>💬 开设一个社区聊天平台</summary>
|
||
<p>
|
||
|
||
> Github 的 issue 并不总是和您的用户沟通最好的地方。如果有需要的话，您可以使用一些聊天平台来和他们讨论：
|
||
>
|
||
> - [Discord](https://discordapp.com)
|
||
> - [Slack](https://slack.com)
|
||
> - [Gitter](https://gitter.im/)
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>🔙 寻求反馈</summary>
|
||
<p>
|
||
|
||
> 用户反馈是改进您项目的最佳方法，他们也许有着能使您的项目变得更好的想法和主意。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>❤️ 建造一个用例库来展示您的用户是如何使用您的项目的</summary>
|
||
<p>
|
||
|
||
> 如果访问者们能够见到具体的用例和成功案例的话，他们会更加信任您的项目，比如 [the vuepress gallery](https://vuepress.gallery/)。
|
||
|
||
</p>
|
||
</details>
|
||
|
||
<br />
|
||
|
||
## 🙏 表示支持
|
||
|
||
如果这份备用单能够帮助到您，请您支持并 ⭐️ 我们的 repository！
|
||
|
||
<br />
|
||
|
||
## ❤️ 贡献者们
|
||
|
||
感谢这群无与伦比的人们：
|
||
|
||
<!-- 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>
|
||
<td align="center"><a href="https://github.com/Antoineoili"><img src="https://avatars1.githubusercontent.com/u/50737365?v=4" width="100px;" alt="Antoine Oili"/><br /><sub><b>Antoine Oili</b></sub></a><br /><a href="https://github.com/zenika-open-source/open-source-promotion-cheat-sheet/commits?author=Antoineoili" title="Documentation">📖</a></td>
|
||
<td align="center"><a href="https://twitter.com/dev_oswld"><img src="https://avatars1.githubusercontent.com/u/40254158?v=4" width="100px;" alt="Oswld TC"/><br /><sub><b>Oswld TC</b></sub></a><br /><a href="#translation-dev-oswld" title="Translation">🌍</a></td>
|
||
<td align="center"><a href="https://yizhiyue.me"><img src="https://avatars3.githubusercontent.com/u/8545277?v=4" width="100px;" alt="Zhiyue Yi"/><br /><sub><b>Zhiyue Yi</b></sub></a><br /><a href="#translation-ZhiyueYi" title="Translation">🌍</a></td>
|
||
</tr>
|
||
</table>
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||
|
||
该项目遵循[all-contributors](https://github.com/all-contributors/all-contributors)说明。欢迎任何形式的贡献！
|