✨ Add points (#7)
This commit is contained in:
Franck Abgrall
GitHub
parent
d1574fb12c
commit
2da060c4be
217
README.md
217
README.md
|
|
@ -7,60 +7,221 @@ List of availables languages:
|
|||
- [English](./README.md)
|
||||
- [Français](./README-fr.md)
|
||||
|
||||
<br />
|
||||
|
||||
---
|
||||
|
||||
<br />
|
||||
|
||||
## 1. 🎢 Preparation step
|
||||
|
||||
- 😎 Choose a cool name for your project
|
||||
<br />
|
||||
|
||||
- 💅 Make your README pretty
|
||||
<details>
|
||||
<summary>😎 Choose a cool name for your project</summary>
|
||||
<p>
|
||||
|
||||
<details>
|
||||
<summary>Details</summary>
|
||||
<p>
|
||||
> Choose a name users can easily remember. It must not necessarly includes keywords related to the technology you're using within your project (ex: [bento-starter](https://github.com/kefranabg/bento-starter)).
|
||||
|
||||
> [List of beautiful readmes](https://github.com/matiassingers/awesome-readme).
|
||||
</p>
|
||||
</details>
|
||||
|
||||
</p>
|
||||
</details>
|
||||
<details>
|
||||
<summary>💅 Make your README pretty</summary>
|
||||
<p>
|
||||
|
||||
- ✨ Provide a demo of your project
|
||||
> README is the first your user will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme).
|
||||
|
||||
- 👌 Insall/Usage must be super easy
|
||||
</p>
|
||||
</details>
|
||||
|
||||
- 📘 Create a clean and well structured documentation
|
||||
<details>
|
||||
<summary>💪 Highlight strong points of your project </summary>
|
||||
<p>
|
||||
|
||||
> Identify your project strengths and make sure that visitors see them at first.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>✨ Provide a demo of your project</summary>
|
||||
<p>
|
||||
|
||||
> README is the first your user will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme).
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>👌 Insall/Usage must be super easy</summary>
|
||||
<p>
|
||||
|
||||
> You'll probably lost users if your project is not user friendly.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>📘 Create a clean and well structured documentation</summary>
|
||||
<p>
|
||||
|
||||
> It is probably the most important step. If your have a small documentation, you can include it in your README. Otherwise, you should probably host it in a different website. Projects like [vuepress](https://v1.vuepress.vuejs.org) helps you creating clean documentations in a simple way.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<br />
|
||||
|
||||
## 2. 📢 Spread the word about your hard works
|
||||
|
||||
- ⭐ Talk about your project to your friends and colleagues to get your first stars before publishing to social networks
|
||||
<br />
|
||||
|
||||
<details>
|
||||
<summary>Details</summary>
|
||||
<p>
|
||||
<details>
|
||||
<summary>⭐ Talk about your project to your friends and colleagues to get your first github stars before publishing to social networks</summary>
|
||||
<p>
|
||||
|
||||
> A minimum of stars make your project more trustable then a zero star project.
|
||||
> A minimum stars amount make your project more trustable than a zero star project. Ask people you know to support your project before doing a public annouccement on social medias.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
</p>
|
||||
</details>
|
||||
|
||||
- ↗️ Share the project on social medias an specialized platforms
|
||||
<details>
|
||||
<summary>↗️ Share the project on social medias an specialized platforms</summary>
|
||||
<p>
|
||||
|
||||
- 📃 Write articles that mention your project
|
||||
> Tell the world about your awesome project! Publish on social medias and specialized platforms:
|
||||
|
||||
- 🕐 Take care to choose the best time to post and share articles
|
||||
- [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>
|
||||
|
||||
- 📘 Manage your communication to make the project be in trending pages
|
||||
<details>
|
||||
<summary>📃 Write articles that mention your project</summary>
|
||||
<p>
|
||||
|
||||
> Write articles to talk about your project (purpose can be the technical stack you used, how your project works, problems you encountered, etc). Publish your articles to [medium](https://medium.com/) or [dev.to](https://dev.to/).
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>🎤 Present your project at conferences/meetups</summary>
|
||||
<p>
|
||||
|
||||
> Presenting your project at conferences or meetupss is a good way to improve its visibility.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>🎥 Record and publish videos presenting your project, how it works, etc
|
||||
</summary>
|
||||
<p>
|
||||
|
||||
> Like conferences, recording is not an easy execise, but it's a great way to get your project famous.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>🕐 Choose the best time to publish on social medias</summary>
|
||||
<p>
|
||||
|
||||
> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>🗑 Don't spam platforms with your promotion</summary>
|
||||
<p>
|
||||
|
||||
> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<br />
|
||||
|
||||
## 3. 🤝 Keep your users
|
||||
|
||||
- 🆕Try to regularly release new versions of your project
|
||||
<br />
|
||||
|
||||
- ❗ Do not let issues open without answer
|
||||
<details>
|
||||
<summary>🆕 Try to regularly release new versions of your project</summary>
|
||||
<p>
|
||||
|
||||
- 🙏 Invite users to contribute
|
||||
> Maintain and improve your project with new releases. Generate changelogs is also a best practice to let your users know about changes.
|
||||
|
||||
- 🏆 Reward contributors
|
||||
</p>
|
||||
</details>
|
||||
|
||||
- 💬 Open a community chat platform
|
||||
<details>
|
||||
<summary>❗ Maintain your project, process opened issues</summary>
|
||||
<p>
|
||||
|
||||
- 🔙 Ask for feedback
|
||||
> Do not let opened issues without response. Be nice with people that took time to open an issue 😉
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>🙏 Invite users to contribute</summary>
|
||||
<p>
|
||||
|
||||
> A healthy project is a project with a community and contributors. Let your users know that you need helps by tagging some issues with `contribution welcome` or `good first issue` labels.
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>🏆 Reward contributors</summary>
|
||||
<p>
|
||||
|
||||
> Be nice with people that helped you! Some open-source projects like [gatsby](https://github.com/gatsbyjs/gatsby) reward contributors with goodies. If you can't afford that (which is probably the case), tweet about the contribution and mention the author ([here is an example of tweet](https://twitter.com/FranckAbgrall/status/1139470547492978688)) open a `Contributors` section to your README in order to publicly thanks them (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)).
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>💬 Open a community chat platform</summary>
|
||||
<p>
|
||||
|
||||
> Github issues are not always the best way to communicate with your users. Use chat platforms to discuss with them:
|
||||
- [Discord](https://discordapp.com)
|
||||
- [Slack](https://slack.com)
|
||||
- [Gitter](https://gitter.im/)
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>🔙 Ask for feedback</summary>
|
||||
<p>
|
||||
|
||||
> User's feedback is the best way to improve your project
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>❤️ Open a use case gallery to show what users built with your project</summary>
|
||||
<p>
|
||||
|
||||
> Visitors will trust your project if they see concrete use cases (ex: [vuepress gallery](https://vuepress.gallery/))
|
||||
|
||||
</p>
|
||||
</details>
|
||||
|
||||
<br />
|
||||
|
|
|
|||
Loading…
Reference in a new issue