diff --git a/.all-contributorsrc b/.all-contributorsrc index d446db9..075fc84 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1,11 +1,6 @@ { "files": [ - "README.md", - "README-fr.md", - "README-de.md", - "README-es.md", - "README-zh-cn.md", - "README-zh-tw.md" + "README.md" ], "imageSize": 100, "commit": false, @@ -63,84 +58,11 @@ "contributions": [ "doc" ] - }, - { - "login": "bpetetot", - "name": "Benjamin Petetot", - "avatar_url": "https://avatars3.githubusercontent.com/u/516360?v=4", - "profile": "https://github.com/bpetetot", - "contributions": [ - "doc" - ] - }, - { - "login": "NickHatBoecker", - "name": "NickHatBoecker", - "avatar_url": "https://avatars0.githubusercontent.com/u/8366071?v=4", - "profile": "https://nick-hat-boecker.de", - "contributions": [ - "translation" - ] - }, - { - "login": "claire", - "name": "Claire Martinez", - "avatar_url": "https://avatars2.githubusercontent.com/u/5114096?v=4", - "profile": "https://github.com/Claire", - "contributions": [ - "translation" - ] - }, - { - "login": "andregamma", - "name": "André Gama", - "avatar_url": "https://avatars2.githubusercontent.com/u/31011359?v=4", - "profile": "https://hazeforum.com/", - "contributions": [ - "doc" - ] - }, - { - "login": "mbernardeau", - "name": "Mathias Bernardeau", - "avatar_url": "https://avatars0.githubusercontent.com/u/7049049?v=4", - "profile": "https://github.com/mbernardeau", - "contributions": [ - "doc" - ] - }, - { - "login": "Antoineoili", - "name": "Antoine Oili", - "avatar_url": "https://avatars1.githubusercontent.com/u/50737365?v=4", - "profile": "https://github.com/Antoineoili", - "contributions": [ - "doc" - ] - }, - { - "login": "dev-oswld", - "name": "Oswld TC", - "avatar_url": "https://avatars1.githubusercontent.com/u/40254158?v=4", - "profile": "https://twitter.com/dev_oswld", - "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", - "commitConvention": "none" + "repoHost": "https://github.com" } diff --git a/CODEOWNERS b/CODEOWNERS deleted file mode 100644 index a499b94..0000000 --- a/CODEOWNERS +++ /dev/null @@ -1,2 +0,0 @@ -* @tbetous @kefranabg @bpetetot @frinyvonnick - diff --git a/README-de.md b/README-de.md deleted file mode 100644 index 71bd761..0000000 --- a/README-de.md +++ /dev/null @@ -1,291 +0,0 @@ -

- oss image -

- -

- - tweet - -

- -

Cheat Sheet: Open Source Projekte bewerben

- -> Dieses Cheat Sheet fasst wichtige Schritte zusammen, die dir dabei helfen sollen, dein Open Source Projekt zu bewerben. Klicke auf einen Punkt, um mehr über das Thema zu erfahren. - -Verfügbare Sprachen: - -- [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) - -Eine Sprache fehlt und du möchtest helfen das Cheat Sheet zu verbessern? [Beteiligung ist gern gesehen](./CONTRIBUTING.md)! - -## 1. 🎢 Vorbereitung - -
- -
-👌 Stell sicher, dass dein Projekt ausgereift ist -

- -> Dein Projekt muss stabil genug sein mit einem Minimum an brauchbaren Features zu funktionieren, um Nutzer zu begeistern. - -

-
- -
-😎 Wähle einen coolen Namen für dein Projekt -

- -> Wähle einen Namen, der leicht zu merken ist. - -

-
- -
-💅 Mach deine README schön -

- -> Die README ist das erste, was deine Besucher sehen werden. Gestalte sie simpel, schön und gut lesbar. [Hier ist eine List mit schönen READMEs](https://github.com/matiassingers/awesome-readme). - -

-
- -
-💪 Heb wichtige Punkte deines Projekts hervor -

- -> Bestimme die Stärken deines Projekts und stell sicher, dass Besucher sie als erstes sehen. - -

-
- -
-✨ Stell eine Demo deines Projekts zur Verfügung -

- -> Besucher wollen schnellstmöglich den Sinn deines Projekts verstehen, wie es funktioniert und wie man es benutzt. Mit einer Demo ist das am einfachsten. Eine Demo könnte folgendes sein: -> -> - Ein animiertes GIF, das zeigt, wie dein Projekt funktioniert -> - Ein Link zu einer Live Demo - -

-
- -
-👌 Installation/Benutzung muss super einfach sein -

- -> Ist dein Projekt nicht nutzerfreundlich, wirst du vermutlich Besucher verlieren. - -

-
- -
-📘 Erstelle eine saubere und gut strukturierte Dokumentation -

- -> Eine gute Dokumentation zu erstellen ist vermutlich der wichtigste Schritt. Eine kurze Dokumentation kannst du in der README anlegen. Andernfalls solltest du sie in eine eigene Webseite einbetten. Diverse Open Source Projekte wie [vuepress](https://v1.vuepress.vuejs.org) können dir dabei helfen, eine saubere Dokumentation zu schreiben. - -

-
- -
- -## 2. 📢 Erzähl der Welt von deiner Arbeit - -
- -
-⭐ Steiger das Vertrauen in dein Projekt, bevor du es auf Social Media Netzwerken veröffentlichst -

- -> Viele Besucher werden die Anzahl der Sterne überprüfen, bevor sie in Erwägung ziehen, das Projekt zu benutzen. Eine kleine Anzahl an Sternen wirkt vertrauenswürdiger als gar keine Sterne. Deshalb solltest du Bekannte fragen, ob sie dein Projekt unterstützen und auf ihren Social Media Kanälen bewerben. - -

-
- -
-↗️ Teile dein Projekt auf Social Media Kanälen und passenden Plattformen -

- -> Erzähl der Welt von deiner tollen Arbeit! Veröffentliche Sie auf Social Media Kanälen und passenden Plattformen: -> -> - [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/) - -

-
- -
-📃 Schreibe Artikel und erwähne dein Projekt -

- -> Schreibe Artikel über dein Projekt. Schreib über die technischen Anforderungen, wie dein Projekt funktioniert, Probleme auf die du gestoßen bist, etc. Mögliche Plattformen zum Veröffentlichen: -> -> - [medium](https://medium.com/) -> - [dev.to](https://dev.to/) -

-
- -
-🎤 Präsentiere dein Projekt auf Konferenzen/Treffen -

- -> Wenn du dein Projekt auf Konferenzen oder Treffen präsentierst, steigert das dessen Bekanntheitsgrad. - -

-
- -
-🎥 Nimm Videos auf, in denen du dein Projekt präsentierst -

- -> Ein Video aufzunehmen ist keine einfache Aufgabe. Allerdings ist es wohl der effizienteste Weg, um dein Projekt bekannt zu machen. - -

-
- -
-🕐 Wähle die beste Zeit für Social Media Beiträge -

- -> Publiziere nicht während den Ferien oder an Wochenenden. Schreib stattdessen lieber in der Mitte der Woche. - -

-
- -
-🗑 Spamm Plattformen nicht mit deiner Werbung zu -

- -> Publiziere nicht zwei Mal auf der selben Plattform. Das gilt als Spam und könnte schlechtes Licht auf dein Projekt werfen. - -

-
- -
- -## 3. 🤝 Bleib präsent und in Kontakt - -
- -
-🆕 Versuche regelmäßig neue Versionen deines Projekts zu veröffentlichen -

- -> Warte und verbessere dein Projekt mit neuen Releases und veröffentliche Changelogs. - -

-
- -
-❗ Warte dein Projekt, bearbeite offene Tickets -

- -> Lass kein offenes Issue unbeantwortet. Sei nett zu den Leuten, die ein Ticket eröffnet haben. 😉 - -

-
- -
-🙏 Lade Nutzer ein mitzumachen -

- -> Ein gesundes Projekt ist ein Projekt mit einer Community und Mitwirkenden. Lass deine Nutzer wissen, dass du Hilfe brauchst, indem du Tickets mit `contribution welcome` oder `good first issue` betitelst. [Siehe github Labels](https://help.github.com/en/articles/about-labels). - -

-
- -
-🏆 Belohne Mitwirkende -

- -> Sei nett zu Leuten, die dir geholfen haben! Manche Open Source Projekte wie [gatsby](https://github.com/gatsbyjs/gatsby) belohnen Mitwirkende mit Goodies. Wenn du dir das nicht leisten kannst, schreib einen Beitrag (auf Twitter oder anderen Plattformen) und erwähne den Autor ([hier ist ein Beispiel zu einem öffentlichen Dankeschön](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Eröffne einen `Mitwirkende` Bereich in deiner README, um den Leuten öffentlich zu danken. Du kannst diese Namen auch in deiner Dokumentation oder auf deiner Webseite zeigen. Hier sind ein paar Beispiele: -> -> - [vuepress (Mitwirkende in der README)](https://github.com/vuejs/vuepress#code-contributors) -> - [Rythm.js (Zufälliger Mitwirkender auf der Demo Seite)](https://okazari.github.io/Rythm.js/) - -

-
- -
-💬 Eröffne einen Chat für die Community -

- -> Github Tickets sind nicht immer der beste Weg, um mit deinen Nutzern zu kommunizieren. Falls nötig, kannst du eine Chat Plattform dafür nutzen: -> -> - [Discord](https://discordapp.com) -> - [Slack](https://slack.com) -> - [Gitter](https://gitter.im/) - -

-
- -
-🔙 Bitte um Feedback -

- -> Nutzer-Feedback ist der beste Weg, um dein Projekt zu verbessern. Jemand hat bestimmt einen Wunsch oder eine Idee, um dein Projekt noch besser zu machen. - -

-
- -
-❤️ Veröffentliche eine Galerie, die zeigt, was andere mit deinem Projekt erschaffen haben -

- -> Besucher werden deinem Projekt vertrauen, wenn sie konkrete Beispiele sehen, zum Beispiel [the vuepress gallery](https://vuepress.gallery/)). - -

-
- -
- -## 🙏 Unterstütz dieses Projekt - -⭐️ Gib diesem Repository einen Stern, wenn das Cheat Sheet dir geholfen hat! - -
- -## ❤️ Mitwirkende - -Unser Dank geht an die folgenden wundervollen Leute: - - - - - - - - - - - - - - - - - - - - - - -
Franck Abgrall
Franck Abgrall
📖		Thomas Betous
Thomas Betous
📖		Eric Briand
Eric Briand
📖		Faustine Godbillot
Faustine Godbillot
📖		Benjamin Plouzennec
Benjamin Plouzennec
📖		Johan Bonneau
Johan Bonneau
📖		Benjamin Petetot
Benjamin Petetot
📖
NickHatBoecker
NickHatBoecker
🌍		Claire Martinez
Claire Martinez
🌍		André Gama
André Gama
📖		Mathias Bernardeau
Mathias Bernardeau
📖		Antoine Oili
Antoine Oili
📖		Oswld TC
Oswld TC
🌍		Zhiyue Yi
Zhiyue Yi
🌍
- - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/README-es.md b/README-es.md deleted file mode 100644 index 0a2dc84..0000000 --- a/README-es.md +++ /dev/null @@ -1,291 +0,0 @@ -

- oss image -

- -

- - tweet - -

- -

Hoja de referencia de promoción al código abierto

- -> Esta hoja de referencia resume los pasos importantes que debes seguir para promover tu proyecto de código abierto en óptimas condiciones. Puedes hacer clic en los elementos para expandir y obtener más información de un tema. - -Lista de lenguajes disponibles: - -- [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) - -¿Un lenguaje falta? ¿Deseas mejorar esta hoja? ¡[Las contribuciones son bienvenidas](./CONTRIBUTING.md)! - -## 1. 🎢 Pasos de preparación - -
- -
-👌 Asegúrate que tu proyecto sea lo suficientemente maduro -

- -> Tu proyecto debe ser lo suficientemente estable con las características mínimas viables con el fin de atraer a los usuarios. - -

-
- -
-😎 Escoge un nombre atractivo para tu proyecto -

- -> Escoge un nombre que los usuarios puedan recordar fácilmente. - -

-
- -
-💅 Haz que tu README sea elegante -

- -> El README es lo primero que verán tus visitantes. Hazlo simple, elegante y fácil de leer. [Aquí hay una lista de ejemplos README](https://github.com/matiassingers/awesome-readme). - -

-
- -
-💪 Destaca los puntos fuertes de tu proyecto -

- -> Identifica las fortalezas de tu proyecto y asegúrate de que los visitantes las vean primero. - -

-
- -
-✨ Proporciona una demostración de tu proyecto -

- -> Los visitantes desean comprender rápidamente el propósito de tu proyecto, cómo funciona y cómo usarlo. Proporciona una demostración es la mejor manera de complacer a los usuarios. Podría ser: -> -> - Un GIF animado que demuestra cómo funciona tu proyecto -> - Un enlace a una demostración - -

-
- -
-👌 Instalación/Manejo debe ser súper fácil -

- -> Probablemente perderás visitantes si tu proyecto no es fácil de usar. - -

-
- -
-📘 Crea una documentación limpia y bien estructurada -

- -> Crear una buena documentación es probablemente el paso más importante. Si tienes una pequeña documentación, puedes incluirla en tu archivo README. De lo contrario, probablemente deberías alojarlo en un sitio web por separado. Algunos proyectos de código abierto como [vuepress](https://v1.vuepress.vuejs.org) pueden ayudarte a crear documentación limpia de una manera simple. - -

-
- -
- -## 2. 📢 Correr la voz sobre tu trabajo - -
- -
-⭐ Haz que tu proyecto sea confiable antes de publicarlo en las redes sociales -

- -> La mayoría de los visitantes comprobarán cuántas estrellas tiene tu proyecto antes de considerar usarlo. Una cantidad mínima de estrellas hace que tu proyecto sea más confiable que un proyecto con cero estrellas. Es por eso que debes pedir a las personas que conoces que apoyen tu proyecto antes de hacer un anuncio público en las redes sociales. - -

-
- -
-↗️ Comparte tu proyecto en redes sociales y plataformas especializadas -

- -> ¡Cuéntale al mundo de tu increíble trabajo! Publica en redes sociales y plataformas especializadas: -> -> - [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/) - -

-
- -
-📃 Escribe artículos que mencionen tu proyecto -

- -> Escribe artículos sobre tu proyecto. El propósito puede ser el conjunto de tecnologías que utilizaste, cómo funciona tu proyecto, los problemas que encontraste, etc. Publica en plataformas como: -> -> - [medium](https://medium.com/) -> - [dev.to](https://dev.to/) -

-
- -
-🎤 Presenta tu proyecto en conferencias/reuniones -

- -> Presentar tu proyecto en conferencias o reuniones es una buena manera de mejorar su visibilidad. - -

-
- -
-🎥 Graba y publica videos sobre tu proyecto, cómo funciona, etc. -

- -> Grabar un video no es una tarea fácil. Sin embargo, es probablemente la forma más eficiente de hacer notorio tu proyecto. - -

-
- -
-🕐 Elige el mejor momento para publicar en las redes sociales -

- -> No publiques durante el período de vacaciones o fines de semana. Por lo general, el mejor momento para publicar en las redes sociales es a mitad de semana. - -

-
- -
-🗑 No hagas spam en plataformas con tu mención -

- -> No publiques dos veces en la misma plataforma. Es considerado como spam y puede causar mala publicidad para tu proyecto. - -

-
- -
- -## 3. 🤝 Conserva a tus usuarios - -
- -
-🆕 Intenta lanzar regularmente nuevas versiones de tu proyecto -

- -> Realiza mantenimiento y mejora tu proyecto con nuevos lanzamientos y genera un registro de cambios. - -

-
- -
-❗ Manten tu proyecto, revisa los problemas pendientes -

- -> No dejes problemas pendientes sin respuesta. Sé amable con las personas que se tomaron el tiempo para dejar una sugerencia. 😉 - -

-
- -
-🙏 Invita a otros usuarios a contribuir -

- -> Un proyecto saludable es un proyecto con una comunidad y contribuidores activos. Informa a tus usuarios que necesita ayuda etiquetando algunos problemas con las etiquetas de `contribution welcome` o `good first issue`. [Ver más etiquetas de github](https://help.github.com/en/articles/about-labels). - -

-
- -
-🏆 Recompensas a los contribuidores -

- -> ¡Sé amable con las personas que te ayudaron! Algunos proyectos de código abierto como [gatsby](https://github.com/gatsbyjs/gatsby) premian a los contribuidores. Si no puedes pagar eso, haz una publicación (en twitter u otras plataformas) sobre la contribución y menciona al autor ([este es un ejemplo de agradecimiento público](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Abre una sección de `Contribuidores` en tu archivo README para agradecerles públicamente o mostrarlos en la documentación de tu proyecto o sitio web. Aquí hay unos ejemplos: -> -> - [vuepress (contribuidores en la sección README)](https://github.com/vuejs/vuepress#code-contributors) -> - [Rythm.js (contribuidores aleatorios destacados en página web)](https://okazari.github.io/Rythm.js/) - -

-
- -
-💬 Abre una plataforma de chat comunitario -

- -> Los problemas pendientes en Github no siempre son la mejor manera de comunicarte con tus usuarios. Si es necesario, puedes usar plataformas de chat para discutir con ellos. -> -> - [Discord](https://discordapp.com) -> - [Slack](https://slack.com) -> - [Gitter](https://gitter.im/) - -

-
- -
-🔙 Pide retroalimentación -

- -> Los comentarios de los usuarios son la mejor manera de mejorar tu proyecto. Probablemente tienen características e ideas que podrían mejorar tu proyecto. - -

-
- -
-❤️ Abre una galería de casos de uso para mostrar a los usuarios que utilizaron tu proyecto -

- -> Los visitantes confiarán en tu proyecto si ven casos de uso concretos e historias de éxito, por ejemplo, [la gallería vuepress](https://vuepress.gallery/). - -

-
- -
- -## 🙏 Muestra tu apoyo - -⭐️ a este repositorio ¡si esta hoja de referencia te ayudó! - -
- -## ❤️ Contribuidores - -Gracias a estas maravillosas personas: - - - - - - - - - - - - - - - - - - - - - - -
Franck Abgrall
Franck Abgrall
📖		Thomas Betous
Thomas Betous
📖		Eric Briand
Eric Briand
📖		Faustine Godbillot
Faustine Godbillot
📖		Benjamin Plouzennec
Benjamin Plouzennec
📖		Johan Bonneau
Johan Bonneau
📖		Benjamin Petetot
Benjamin Petetot
📖
NickHatBoecker
NickHatBoecker
🌍		Claire Martinez
Claire Martinez
🌍		André Gama
André Gama
📖		Mathias Bernardeau
Mathias Bernardeau
📖		Antoine Oili
Antoine Oili
📖		Oswld TC
Oswld TC
🌍		Zhiyue Yi
Zhiyue Yi
🌍
- - - -Este projecto sigue la especificación [all-contributors](https://github.com/all-contributors/all-contributors). ¡Las contribuciones de cualquier tipo son bienvenidas! diff --git a/README-fr.md b/README-fr.md index bd99250..da951dd 100644 --- a/README-fr.md +++ b/README-fr.md @@ -4,22 +4,18 @@

- tweet + tweet

Cheat sheet : Promouvoir un projet open-source

-> Ce cheat sheet résume les étapes importantes à suivre pour promouvoir un projet open-source dans les meilleures conditions. Il est possible d’afficher des informations supplémentaires pour un élément de la liste en cliquant dessus. +> Ce cheet sheet résume les étapes importantes à suivre pour promouvoir un projet open-source dans les meilleures conditions. Il est possible d’afficher des informations supplémentaires pour un élément de la liste en cliquant dessus. Langages disponibles : - [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) Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat sheet ? [Les contributions sont les bienvenues](./CONTRIBUTING.md) ! @@ -258,34 +254,3 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat ## 🙏 Montrez votre support N'hésitez pas à mettre une ⭐ si ce projet vous a aidé. - -## ❤️ Contributeurs - -Merci à tous les formidables contributeurs: - - - - - - - - - - - - - - - - - - - - - - -
Franck Abgrall
Franck Abgrall
📖		Thomas Betous
Thomas Betous
📖		Eric Briand
Eric Briand
📖		Faustine Godbillot
Faustine Godbillot
📖		Benjamin Plouzennec
Benjamin Plouzennec
📖		Johan Bonneau
Johan Bonneau
📖		Benjamin Petetot
Benjamin Petetot
📖
NickHatBoecker
NickHatBoecker
🌍		Claire Martinez
Claire Martinez
🌍		André Gama
André Gama
📖		Mathias Bernardeau
Mathias Bernardeau
📖		Antoine Oili
Antoine Oili
📖		Oswld TC
Oswld TC
🌍		Zhiyue Yi
Zhiyue Yi
🌍
- - - -Ce projet suit la spécification [all-contributors](https://github.com/all-contributors/all-contributors). Les contributions de tout type sont les bienvenues ! diff --git a/README-zh-cn.md b/README-zh-cn.md deleted file mode 100644 index cfb3acb..0000000 --- a/README-zh-cn.md +++ /dev/null @@ -1,294 +0,0 @@ -

- oss image -

- -

- - tweet - -

- -

开源项目推广备忘单

- -> 这篇备忘单为您总结了一些关于如何最好地推广您的开源项目的重要步骤，您可以点击并展开下列选项以了解更多详情。 - -现已支持以下语言： - -- [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. 🎢 准备阶段 - -
- -
-👌 保证您的项目已经足够成熟 -

- -> 您的项目必须足够稳定，并且拥有一些最低可行功能用以吸引用户们。 - -

-
- -
-😎 为您的项目挑选一个炫酷的名字 -

- -> 挑选一个用户们能轻易记住的名字。 - -

-
- -
-💅 把您的README文档写得干净漂亮 -

- -> 您的访客们的第一件事就是阅读您的 README 文档，所以您得确保它干净漂亮、易于阅读。[这些优秀的 README 文档可以为您提供参考](https://github.com/matiassingers/awesome-readme)。 - -

-
- -
-💪 强调您的项目中最闪耀的亮点 -

- -> 找出您的项目的强大之处并确保您的访客们在第一时间了解到它们。 - -

-
- -
-✨ 提供一个您项目的演示或示例 -

- -> 访客们通常希望迅速了解您的项目的目标，它的工作原理以及应该如何使用它。为您的项目提供一个演示或者示例可以很好地满足访客们的需求，比如说： -> -> - 利用 GIF 动画来展示您项目的工作原理 -> - 提供一个在线演示的网页连接 - -

-
- -
-👌 安装和使用必须超级简单 -

- -> 您的项目不够用户友好可能会造成访客们的流失。 - -

-
- -
-📘 创建一个干净整洁的结构化文档 -

- -> 一个优秀的文档也许是最为重要的一步了。如果您的文档比较小的话，您可以直接将它包含在 README 文档里。否则的话，您或许应该将您的文档托管在一个独立的网站上面。一些开源项目比如 [vuepress](https://v1.vuepress.vuejs.org) 可以帮助您非常容易地创建干净整洁的文档。 - -

-
- -
- -## 2. 📢 宣传您的辛苦工作 - -
- -
-⭐ 在社交网络上发布您的项目之前，保证它是可以信赖的 -

- -> 许多访客会在考虑使用项目之前，先查看项目获得过得 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/) - -

-
- -
-🎤 在正式会议或线下聚会上介绍您的项目 -

- -> 在正式会议或线下聚会上介绍您的项目是提高知名度的好办法。 - -

-
- -
-🎥 记录并发布项目介绍和原理解释等的视频 -

- -> 虽然录制视频并不轻松，但它也许是能让您的项目出名的最有效的办法。 - -

-
- -
-🕐 选择最好的时间在社交媒体上发布 -

- -> 不要在假期或者周末发布您的项目。通常最适合在社交网络上发布的时间是一周里中间的那几天。 - -

-
- -
-🗑 不要在平台上过度宣传 -

- -> 不要在相同的平台上发布两次。这将会被视为过度的宣传，并且有可能为您的项目招致负面宣传。 - -

-
- -
- -## 3. 🤝 留住您的用户们 - -
- -
-🆕 尽量为您的项目定期发布新版本 -

- -> 维护并且改进您的项目，比如：新版本的发布和撰写变更记录。 - -

-
- -
-❗ 维护您的项目并处理未解决的issue -

- -> 别让 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/)。 - -

-
- -
- -## 🙏 表示支持 - -如果这份备用单能够帮助到您，请您支持并 ⭐️ 我们的 repository！ - -
- -## ❤️ 贡献者们 - -感谢这群无与伦比的人们： - - - - - - - - - - - - - - - - - - - - - - -
Franck Abgrall
Franck Abgrall
📖		Thomas Betous
Thomas Betous
📖		Eric Briand
Eric Briand
📖		Faustine Godbillot
Faustine Godbillot
📖		Benjamin Plouzennec
Benjamin Plouzennec
📖		Johan Bonneau
Johan Bonneau
📖		Benjamin Petetot
Benjamin Petetot
📖
NickHatBoecker
NickHatBoecker
🌍		Claire Martinez
Claire Martinez
🌍		André Gama
André Gama
📖		Mathias Bernardeau
Mathias Bernardeau
📖		Antoine Oili
Antoine Oili
📖		Oswld TC
Oswld TC
🌍		Zhiyue Yi
Zhiyue Yi
🌍
- - - -该项目遵循[all-contributors](https://github.com/all-contributors/all-contributors)说明。欢迎任何形式的贡献！ diff --git a/README-zh-tw.md b/README-zh-tw.md deleted file mode 100644 index 4bb6727..0000000 --- a/README-zh-tw.md +++ /dev/null @@ -1,294 +0,0 @@ -

- oss image -

- -

- - tweet - -

- -

開源項目推廣備忘單

- -> 這篇備忘單為您總結了一些關於如何最好地推廣您的開源項目的重要步驟，您可以點擊並展開下列選項以了解更多詳情。 - -現已支持以下語言： - -- [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. 🎢 準備階段 - -
- -
-👌 保證您的項目已經足夠成熟 -

- -> 您的項目必須足夠穩定，並且擁有一些最低可行功能用以吸引用戶們。 - -

-
- -
-😎 為您的項目挑選一個炫酷的名字 -

- -> 挑選一個用戶們能輕易記住的名字。 - -

-
- -
-💅 把您的README文檔寫得幹淨漂亮 -

- -> 您的訪客們的第一件事就是閱讀您的 README 文檔，所以您得確保它幹淨漂亮、易於閱讀。[這些優秀的 README 文檔可以為您提供參考](https://github.com/matiassingers/awesome-readme)。 - -

-
- -
-💪 強調您的項目中最閃耀的亮點 -

- -> 找出您的項目的強大之處並確保您的訪客們在第一時間了解到它們。 - -

-
- -
-✨ 提供一個您項目的演示或示例 -

- -> 訪客們通常希望迅速了解您的項目的目標，它的工作原理以及應該如何使用它。為您的項目提供一個演示或者示例可以很好地滿足訪客們的需求，比如說： -> -> - 利用 GIF 動畫來展示您項目的工作原理 -> - 提供一個在線演示的網頁連接 - -

-
- -
-👌 安裝和使用必須超級簡單 -

- -> 您的項目不夠用戶友好可能會造成訪客們的流失。 - -

-
- -
-📘 創建一個幹淨整潔的結構化文檔 -

- -> 一個優秀的文檔也許是最為重要的一步了。如果您的文檔比較小的話，您可以直接將它包含在 README 文檔裏。否則的話，您或許應該將您的文檔托管在一個獨立的網站上麵。一些開源項目比如 [vuepress](https://v1.vuepress.vuejs.org) 可以幫助您非常容易地創建幹淨整潔的文檔。 - -

-
- -
- -## 2. 📢 宣傳您的辛苦工作 - -
- -
-⭐ 在社交網絡上發布您的項目之前，保證它是可以信賴的 -

- -> 許多訪客會在考慮使用項目之前，先查看項目獲得過得 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/) - -

-
- -
-🎤 在正式會議或線下聚會上介紹您的項目 -

- -> 在正式會議或線下聚會上介紹您的項目是提高知名度的好辦法。 - -

-
- -
-🎥 記錄並發布項目介紹和原理解釋等的視頻 -

- -> 雖然錄製視頻並不輕鬆，但它也許是能讓您的項目出名的最有效的辦法。 - -

-
- -
-🕐 選擇最好的時間在社交媒體上發布 -

- -> 不要在假期或者周末發布您的項目。通常最適合在社交網絡上發布的時間是一周裏中間的那幾天。 - -

-
- -
-🗑 不要在平台上過度宣傳 -

- -> 不要在相同的平台上發布兩次。這將會被視為過度的宣傳，並且有可能為您的項目招致負麵宣傳。 - -

-
- -
- -## 3. 🤝 留住您的用戶們 - -
- -
-🆕 盡量為您的項目定期發布新版本 -

- -> 維護並且改進您的項目，比如：新版本的發布和撰寫變更記錄。 - -

-
- -
-❗ 維護您的項目並處理未解決的issue -

- -> 別讓 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/)。 - -

-
- -
- -## 🙏 表示支持 - -如果這份備用單能夠幫助到您，請您支持並 ⭐️ 我們的 repository！ - -
- -## ❤️ 貢獻者們 - -感謝這群無與倫比的人們： - - - - - - - - - - - - - - - - - - - - - - -
Franck Abgrall
Franck Abgrall
📖		Thomas Betous
Thomas Betous
📖		Eric Briand
Eric Briand
📖		Faustine Godbillot
Faustine Godbillot
📖		Benjamin Plouzennec
Benjamin Plouzennec
📖		Johan Bonneau
Johan Bonneau
📖		Benjamin Petetot
Benjamin Petetot
📖
NickHatBoecker
NickHatBoecker
🌍		Claire Martinez
Claire Martinez
🌍		André Gama
André Gama
📖		Mathias Bernardeau
Mathias Bernardeau
📖		Antoine Oili
Antoine Oili
📖		Oswld TC
Oswld TC
🌍		Zhiyue Yi
Zhiyue Yi
🌍
- - - -該項目遵循[all-contributors](https://github.com/all-contributors/all-contributors)說明。歡迎任何形式的貢獻！ diff --git a/README.md b/README.md index 35a9225..acee723 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,16 @@

Open source promotion cheat sheet

+ > This cheat sheet summarizes important steps you should follow to promote your open source project in the best conditions. You can click items to expand and get more information from a topic. List of available languages: - [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) A language is missing? Want to improve this cheat sheet? [Contributions are welcome](./CONTRIBUTING.md)! -[A PDF version of this cheat sheet is available here.](./pdf/cheat-sheet.pdf) - ## 1. 🎢 Preparation step
@@ -275,16 +270,6 @@ Thanks go to these wonderful people: Faustine Godbillot
Faustine Godbillot
📖 Benjamin Plouzennec
Benjamin Plouzennec
📖 Johan Bonneau
Johan Bonneau
📖 - Benjamin Petetot
Benjamin Petetot
📖 - - - NickHatBoecker
NickHatBoecker
🌍 - Claire Martinez
Claire Martinez
🌍 - André Gama
André Gama
📖 - Mathias Bernardeau
Mathias Bernardeau
📖 - Antoine Oili
Antoine Oili
📖 - Oswld TC
Oswld TC
🌍 - Zhiyue Yi
Zhiyue Yi
🌍 diff --git a/pdf/cheat-sheet.pdf b/pdf/cheat-sheet.pdf deleted file mode 100644 index 3a8c57b..0000000 Binary files a/pdf/cheat-sheet.pdf and /dev/null differ