-> 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)). +> Choose a short name users can easily remember.
@@ -37,7 +37,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> README is the first thing 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). +> README is the first thing your vistors will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme).
@@ -67,7 +67,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> You'll probably lost users if your project is not user friendly. +> You'll probably lost visitors if your project is not user friendly.
@@ -76,7 +76,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> Creating a good documentation is probably the most important step. If you have a small documentation, you can directly include it in your README. Otherwise, you should probably host it in a separate website. Projects like [vuepress](https://v1.vuepress.vuejs.org) helps you creating clean documentations in a simple way. +> Creating a good documentation is probably the most important step. If you have a small documentation, you can include it within your README. Otherwise, you should probably host it in a separate website. Some open-source projects like [vuepress](https://v1.vuepress.vuejs.org) helps you creating clean documentations in a simple way.
@@ -91,7 +91,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> A minimum amount of stars makes your project more trustable than a project with zero star. Ask people you know to support your project before doing a public announcement on social medias. +> Most visitors will check how many stars the project got before considering using it. A minimum amount of stars makes your project more trustable than a project with zero star. This is why you should ask people you know to support your project before doing a public announcement on social medias.
@@ -120,8 +120,10 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> Write articles 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/). - +> Write articles about your project. Purpose can be the technical stack you used, how your project works, problems you encountered, etc. Post to publishing platforms: +> +> - [medium](https://medium.com/) +> - [dev.to](https://dev.to/)
@@ -172,7 +174,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> Maintain and improve your project with new releases. Generate changelogs is also a best practice, it allows your users to know about the latest changes. +> Maintain and improve your project with new releases and generate changelogs.
@@ -190,7 +192,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> A healthy project is a project with a community and contributors. Let your users know that you need help by tagging some issues with `contribution welcome` or `good first issue` labels. +> A healthy project is a project with a community and contributors. Let your users know that you need help by tagging some issues with `contribution welcome` or `good first issue` labels. [See github labels](https://help.github.com/en/articles/about-labels).
@@ -199,7 +201,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> 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, do a public post (on twitter or other platforms) about the contribution and mention the author ([here is an example of tweet](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Open a `Contributors` section in your README to publicly thanks them (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)). +> 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, do a public post (on twitter or other platforms) about the contribution and mention the author ([here is an example of public thanks](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Open a `Contributors` section in your README to publicly thanks them (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)).
@@ -208,7 +210,7 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we-> Github issues are not always the best way to communicate with your users. Use chat platforms to discuss with them: +> Github issues are not always the best way to communicate with your users. If necessary, you can use chat platforms to discuss with them: > > - [Discord](https://discordapp.com) > - [Slack](https://slack.com)