diff --git a/.all-contributorsrc b/.all-contributorsrc index 66bd643..d446db9 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -3,7 +3,9 @@ "README.md", "README-fr.md", "README-de.md", - "README-es.md" + "README-es.md", + "README-zh-cn.md", + "README-zh-tw.md" ], "imageSize": 100, "commit": false, @@ -124,11 +126,21 @@ "contributions": [ "translation" ] + }, + { + "login": "ZhiyueYi", + "name": "Zhiyue Yi", + "avatar_url": "https://avatars3.githubusercontent.com/u/8545277?v=4", + "profile": "https://yizhiyue.me", + "contributions": [ + "translation" + ] } ], "contributorsPerLine": 7, "projectName": "open-source-promotion-cheat-sheet", "projectOwner": "zenika-open-source", "repoType": "github", - "repoHost": "https://github.com" + "repoHost": "https://github.com", + "commitConvention": "none" } diff --git a/README-de.md b/README-de.md index 187ae8d..71bd761 100644 --- a/README-de.md +++ b/README-de.md @@ -10,7 +10,6 @@
+ +
+ ++ + + +
+ ++ +> 您的项目必须足够稳定,并且拥有一些最低可行功能用以吸引用户们。 + +
++ +> 挑选一个用户们能轻易记住的名字。 + +
++ +> 您的访客们的第一件事就是阅读您的 README 文档,所以您得确保它干净漂亮、易于阅读。[这些优秀的 README 文档可以为您提供参考](https://github.com/matiassingers/awesome-readme)。 + +
++ +> 找出您的项目的强大之处并确保您的访客们在第一时间了解到它们。 + +
++ +> 访客们通常希望迅速了解您的项目的目标,它的工作原理以及应该如何使用它。为您的项目提供一个演示或者示例可以很好地满足访客们的需求,比如说: +> +> - 利用 GIF 动画来展示您项目的工作原理 +> - 提供一个在线演示的网页连接 + +
++ +> 您的项目不够用户友好可能会造成访客们的流失。 + +
++ +> 一个优秀的文档也许是最为重要的一步了。如果您的文档比较小的话,您可以直接将它包含在 README 文档里。否则的话,您或许应该将您的文档托管在一个独立的网站上面。一些开源项目比如 [vuepress](https://v1.vuepress.vuejs.org) 可以帮助您非常容易地创建干净整洁的文档。 + +
++ +> 许多访客会在考虑使用项目之前,先查看项目获得过得 star 数量。只需要一些 star 就能让您的项目比没有任何 star 的项目更加值得信赖,这就是为什么您应该在社交网络上公开宣布之前,请您认识的人支持您的项目。 + +
++ +> 向世界展示您无与伦比的作品!您可以在以下社交媒体和专业平台上发布: +> +> - [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/) + +
++ +> 为您的项目写一些关于您项目的文章。您可以在其中分享您使用到的技术栈、您项目的工作原理和您遇到过得问题等等。然后把这些文章发布在这些平台上: +> +> - [medium](https://medium.com/) +> - [dev.to](https://dev.to/) + +
++ +> 在正式会议或线下聚会上介绍您的项目是提高知名度的好办法。 + +
++ +> 虽然录制视频并不轻松,但它也许是能让您的项目出名的最有效的办法。 + +
++ +> 不要在假期或者周末发布您的项目。通常最适合在社交网络上发布的时间是一周里中间的那几天。 + +
++ +> 不要在相同的平台上发布两次。这将会被视为过度的宣传,并且有可能为您的项目招致负面宣传。 + +
++ +> 维护并且改进您的项目,比如:新版本的发布和撰写变更记录。 + +
++ +> 别让 issue 一直处于未解决的状态并且对此毫无回应。对那些花费自己时间提交 issue 的用户们好一点。 😉 + +
++ +> 一个健康的项目通常拥有一个社区和许多贡献者们。在一些 issue 上标注`contribution welcome`标签或者`good first issue`标签来让您的用户们知道您需要帮助。[关于 github 标签](https://help.github.com/en/articles/about-labels)。 + +
++ +> 为那些帮助过您的人们鼓掌喝彩! 一些开源项目像是[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/) + +
++ +> Github 的 issue 并不总是和您的用户沟通最好的地方。如果有需要的话,您可以使用一些聊天平台来和他们讨论: +> +> - [Discord](https://discordapp.com) +> - [Slack](https://slack.com) +> - [Gitter](https://gitter.im/) + +
++ +> 用户反馈是改进您项目的最佳方法,他们也许有着能使您的项目变得更好的想法和主意。 + +
++ +> 如果访问者们能够见到具体的用例和成功案例的话,他们会更加信任您的项目,比如 [the vuepress gallery](https://vuepress.gallery/)。 + +
+Franck Abgrall 📖 |
+ Thomas Betous 📖 |
+ Eric Briand 📖 |
+ Faustine Godbillot 📖 |
+ Benjamin Plouzennec 📖 |
+ Johan Bonneau 📖 |
+ Benjamin Petetot 📖 |
+
NickHatBoecker 🌍 |
+ Claire Martinez 🌍 |
+ André Gama 📖 |
+ Mathias Bernardeau 📖 |
+ Antoine Oili 📖 |
+ Oswld TC 🌍 |
+ Zhiyue Yi 🌍 |
+
+ +
+ ++ + + +
+ ++ +> 您的項目必須足夠穩定,並且擁有一些最低可行功能用以吸引用戶們。 + +
++ +> 挑選一個用戶們能輕易記住的名字。 + +
++ +> 您的訪客們的第一件事就是閱讀您的 README 文檔,所以您得確保它幹淨漂亮、易於閱讀。[這些優秀的 README 文檔可以為您提供參考](https://github.com/matiassingers/awesome-readme)。 + +
++ +> 找出您的項目的強大之處並確保您的訪客們在第一時間了解到它們。 + +
++ +> 訪客們通常希望迅速了解您的項目的目標,它的工作原理以及應該如何使用它。為您的項目提供一個演示或者示例可以很好地滿足訪客們的需求,比如說: +> +> - 利用 GIF 動畫來展示您項目的工作原理 +> - 提供一個在線演示的網頁連接 + +
++ +> 您的項目不夠用戶友好可能會造成訪客們的流失。 + +
++ +> 一個優秀的文檔也許是最為重要的一步了。如果您的文檔比較小的話,您可以直接將它包含在 README 文檔裏。否則的話,您或許應該將您的文檔托管在一個獨立的網站上麵。一些開源項目比如 [vuepress](https://v1.vuepress.vuejs.org) 可以幫助您非常容易地創建幹淨整潔的文檔。 + +
++ +> 許多訪客會在考慮使用項目之前,先查看項目獲得過得 star 數量。隻需要一些 star 就能讓您的項目比沒有任何 star 的項目更加值得信賴,這就是為什麼您應該在社交網絡上公開宣布之前,請您認識的人支持您的項目。 + +
++ +> 向世界展示您無與倫比的作品!您可以在以下社交媒體和專業平台上發布: +> +> - [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/) + +
++ +> 為您的項目寫一些關於您項目的文章。您可以在其中分享您使用到的技術棧、您項目的工作原理和您遇到過得問題等等。然後把這些文章發布在這些平台上: +> +> - [medium](https://medium.com/) +> - [dev.to](https://dev.to/) + +
++ +> 在正式會議或線下聚會上介紹您的項目是提高知名度的好辦法。 + +
++ +> 雖然錄製視頻並不輕鬆,但它也許是能讓您的項目出名的最有效的辦法。 + +
++ +> 不要在假期或者周末發布您的項目。通常最適合在社交網絡上發布的時間是一周裏中間的那幾天。 + +
++ +> 不要在相同的平台上發布兩次。這將會被視為過度的宣傳,並且有可能為您的項目招致負麵宣傳。 + +
++ +> 維護並且改進您的項目,比如:新版本的發布和撰寫變更記錄。 + +
++ +> 別讓 issue 一直處於未解決的狀態並且對此毫無回應。對那些花費自己時間提交 issue 的用戶們好一點。 😉 + +
++ +> 一個健康的項目通常擁有一個社區和許多貢獻者們。在一些 issue 上標注`contribution welcome`標簽或者`good first issue`標簽來讓您的用戶們知道您需要幫助。[關於 github 標簽](https://help.github.com/en/articles/about-labels)。 + +
++ +> 為那些幫助過您的人們鼓掌喝彩! 一些開源項目像是[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/) + +
++ +> Github 的 issue 並不總是和您的用戶溝通最好的地方。如果有需要的話,您可以使用一些聊天平台來和他們討論: +> +> - [Discord](https://discordapp.com) +> - [Slack](https://slack.com) +> - [Gitter](https://gitter.im/) + +
++ +> 用戶反饋是改進您項目的最佳方法,他們也許有著能使您的項目變得更好的想法和主意。 + +
++ +> 如果訪問者們能夠見到具體的用例和成功案例的話,他們會更加信任您的項目,比如 [the vuepress gallery](https://vuepress.gallery/)。 + +
+Franck Abgrall 📖 |
+ Thomas Betous 📖 |
+ Eric Briand 📖 |
+ Faustine Godbillot 📖 |
+ Benjamin Plouzennec 📖 |
+ Johan Bonneau 📖 |
+ Benjamin Petetot 📖 |
+
NickHatBoecker 🌍 |
+ Claire Martinez 🌍 |
+ André Gama 📖 |
+ Mathias Bernardeau 📖 |
+ Antoine Oili 📖 |
+ Oswld TC 🌍 |
+ Zhiyue Yi 🌍 |
+