From ed4d3a723e50efa81686c189faf88dacb836f258 Mon Sep 17 00:00:00 2001
From: Niusha Pakseresht
+
+
+
+
+
+
+
+> Барноме бояд ба қадр кофи поӣдор бошад то корбарон мушкели дар истифоди аз он надоште бошанд.
+
+
+
+> Номи бароӣ барноме интихоб конид ки корбарон ба роҳати он ро ба хотер бесепаранд.
+
+
+
+> README аввалин жиз аст ке боздиданегон он ро мебинанд пас он ро соде зибо ва осон бароӣ хондан конед. [инҷо листи аз намунеҳоӣ READMEs муҷуд аст](https://github.com/matiassingers/awesome-readme).
+
+
+
+> Итминон ҳосел конид ке нақот қот проҷе бештар тавосут боздиданигон мушоҳиде шавад.
+
+
+
+> Visitors will want to quickly understand the purpose of your project, how it works and how to use it. Providing a demo is the best way to satisfy users. It could be:
+>
+> - An animated GIF demonstrating how your project works
+> - A link to a live demo
+
+
+
+> You'll probably lose visitors if your project is not user-friendly.
+
+
+
+> 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) can help you creating clean documentation in a simple way.
+
+
+
+> Most visitors will check how many stars the project has 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 media.
+
+
+
+> Tell the World about your awesome work! Publish on social media and specialized platforms:
+>
+> - [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/)
+
+
+
+> 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/)
+
+
+> Presenting your project at conferences or meetups is a good way to improve its visibility.
+
+
+
+> Recording a video is not an easy exercise. However it's probably the most efficient way to make your project famous.
+
+
+
+> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week.
+
+
+
+> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.
+
+
+
+> Maintain and improve your project with new releases and generate changelogs.
+
+
+
+> Do not let opened issues without response. Be nice with people that took time to open issues. 😉
+
+
+
+> 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).
+
+
+
+> 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 thank them or showcase them on your project documentation or website. Here are some examples:
+>
+> - [vuepress (contributors README section)](https://github.com/vuejs/vuepress#code-contributors)
+> - [Rythm.js (random highlighted contributor on demo page)](https://okazari.github.io/Rythm.js/)
+
+
+
+> 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)
+> - [Gitter](https://gitter.im/)
+
+
+
+> User feedback is the best way to improve your project. They probably have features and ideas that could make your project better.
+
+
+
+> Visitors will trust your project if they see concrete use cases and success stories, e.g., [the vuepress gallery](https://vuepress.gallery/)).
+
+
-> Visitors will want to quickly understand the purpose of your project, how it works and how to use it. Providing a demo is the best way to satisfy users. It could be:
+> Мумкин аст боздидкунандигон дар боздид аввал наҳви кор ҳадаф барнома ро мутиваҷа нашаванд пас шумо митавонид аз роҳ ҳоӣ зир як дему аз барнома ро дар маъраз намояш қарор даҳид :
>
-> - An animated GIF demonstrating how your project works
-> - A link to a live demo
+> - Як фоӣл GIF ки наҳва кор кард барнома ро намояш мидаҳад
+> - Як линк ки боздид кунанда ро би дему мунтаҷил кунанд
Роҳнамаӣ моъарефи ва тосъи проҷеҳои опен сурс
+
+
+> Ин маҳтави ба шумо комак миконад то барноме "опеи сурс" ход ро бехтар ва сарих тар моъарефи конид.
+
+Лист соӣр забонҳои муҷуд:
+
+- [English](./README.md)
+- [Français](./README-fr.md)
+- [Deutsch](./README-de.md)
+- [Тоҷикӣ](./README-tg.md)
+
+A language is missing? Want to improve this cheat sheet? [Contributions are welcome](./CONTRIBUTING.md)!
+
+[Ин роҳнама PDF насхе](./pdf/cheat-sheet.pdf)
+
+## 1. 🎢 Омодегӣ
+
+
+
+👌 Диқат конид барномаӣ шома ба қадр кофи тосъе доде шоде бошад
+😎 Як исм хоб бароӣ барноме интихоб конид.
+💅 Тамиз ва коро бароӣ барноме як README беневисид.
+💪 Нақот ҷот проҷе ро бештар дар муъорезе намоӣш қарор даҳид.
+✨ Provide a demo of your project
+👌 Install/Usage must be super easy
+📘 Create a clean and well structured documentation
+
+
+## 2. 📢 Spread the word about your hard works
+
+
+
+⭐ Make your project trustable before publishing it on social networks
+↗️ Share the project on social media and specialized platforms
+📃 Write articles that mention your project
+🎤 Present your project at conferences/meetups
+🎥 Record and publish videos presenting your project, how it works, etc
+🕐 Choose the best time to publish on social media
+🗑 Don't spam platforms with your promotion
+
+
+## 3. 🤝 Keep your users
+
+
+
+🆕 Try to regularly release new versions of your project
+❗ Maintain your project, process opened issues
+🙏 Invite users to contribute
+🏆 Reward contributors
+💬 Open a community chat platform
+🔙 Ask for feedback
+❤️ Open a use case gallery to show what users built with your project
+
+
+## 🙏 Show your support
+
+⭐️ this repository if this cheat sheet helped you!
+
+
+
+## ❤️ Contributors
+
+Thanks go to these wonderful people:
+
+
+
+✨ Provide a demo of your project
+✨ Як дему аз барномаӣ худ намояш даҳид
-> You'll probably lose visitors if your project is not user-friendly. +> Шумо иҳтимол бисиори аз боздид кунандигон пруҷе ро замони ки барнома коро ва сода набошад аз даст хоҳид дод.
-> 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) can help you creating clean documentation in a simple way. +> Сохт мустанадот ҷузв муҳимтарин мараҳл аст. Агар шумо як мустанад кутоҳ бароӣ пруҷе худ дорид, митавонид он ро ҳамроҳ бо фоил README дар маъраз намояш умум қарор даҳид. Мустанадоти ҳамун [vuepress](https://v1.vuepress.vuejs.org) митавонанд би шумо кумак кунанд то мустанадот пруҷи худ ро равон ва зибо бинивисид.
-> Most visitors will check how many stars the project has 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 media. +> Биштар боздид кунандигон би мизон ситора ҳоӣ барномаӣ шумо дар шабаки ҳоӣ иҷтимоҳи ва фурушгоҳ ҳо туҷи хоҳанд кард. Таъдод ситора ҳоӣ биштар барномаӣ шумо ро муваррад иътимод тар ҷулу мидаҳад, пас аз корбарон худ бихоҳид аз шумо дар ин муваррад ҳимоят кунанд !
> Барноме бояд ба қадр кофи поӣдор бошад то корбарон мушкели дар истифоди аз он надоште бошанд. @@ -56,10 +56,10 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Итминон ҳосел конид ке нақот қот проҷе бештар тавосут боздиданигон мушоҳиде шавад. +> Итминон ҳосел конид ке нақот қот лоиҳа бештар тавосут боздиданигон мушоҳиде шавад.
-> Мумкин аст боздидкунандигон дар боздид аввал наҳви кор ҳадаф барнома ро мутиваҷа нашаванд пас шумо митавонид аз роҳ ҳоӣ зир як дему аз барнома ро дар маъраз намояш қарор даҳид :
+> Мумкин аст боздидкунандигон дар боздид аввал наҳва кор ҳадаф барнома ро мутиваҷа нашаванд пас шумо митавонид аз роҳ ҳоӣ зир як дему аз барнома ро дар маъраз намояш қарор даҳид :
>
> - Як фоил GIF ки наҳва кор кард барнома ро намояш мидаҳад
> - Як линк ки боздид кунанда ро би дему мунтаҷил кунанд
@@ -80,16 +80,16 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Шумо иҳтимол бисиори аз боздид кунандигон пруҷе ро замони ки барнома коро ва сода набошад аз даст хоҳид дод. +> Шумо иҳтимол бисиори аз боздид кунандигон лоиҳа ро замони ки барнома коро ва сода набошад аз даст хоҳид дод.
-> Сохт мустанадот ҷузв муҳимтарин мараҳл аст. Агар шумо як мустанад кутоҳ бароӣ пруҷе худ дорид, митавонид он ро ҳамроҳ бо фоил README дар маъраз намояш умум қарор даҳид. Мустанадоти ҳамун [vuepress](https://v1.vuepress.vuejs.org) митавонанд би шумо кумак кунанд то мустанадот пруҷи худ ро равон ва зибо бинивисид. +> Сохт мустанадот ҷузв муҳимтарин мараҳл аст. Агар шумо як мустанад кутоҳ бароӣ лоиҳа худ дорид, митавонид он ро ҳамроҳ бо фоил README дар маъраз намояш умум қарор даҳид. Мустанадоти ҳамун [vuepress](https://v1.vuepress.vuejs.org) митавонанд би шумо кумак кунанд то мустанадот пруҷи худ ро равон ва зибо бинивисид.
-> Tell the World about your awesome work! Publish on social media and specialized platforms: +> Дарбора кор олӣ худ дар шабака ҳоӣ иҷтимоъи ва платформ ҳоӣ ихтисоси мисл абзор ҳоӣ зир бигуӣд : > > - [Twitter](https://twitter.com) > - [Linkedin](https://www.linkedin.com/) @@ -130,10 +130,10 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> 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/) @@ -141,37 +141,37 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Presenting your project at conferences or meetups is a good way to improve its visibility. +> Муъарифи лоиҳа дар кунфиронс ҳо митавонад ба шумо дар афзояш мизон боздид лоиҳа кумак кунад !
-> Recording a video is not an easy exercise. However it's probably the most efficient way to make your project famous. +> Забт видию кор осони нист вали ба машҳур шудан барномаӣ шумо кумак хоҳад кард.
-> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week. +> Барнома ро дар таътилот ва охар ҳафта ҳо мунташир ин кор боъс камтар дида шудан шумо мишавад, он маъмуло ин кор ро дар васат ҳафта анҷом даҳид.
-> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project. +> Ҳаргиз дубора як таблиқ ро дар як шабака иҷтимоъи тикрор наконид, дар ин сурат спам дар назар гирифта шуда ва нодида гирифти мишавад, ва тошир иҷтимоъи бади ро бароӣ лоиҳаӣ шумо хоҳад гузошт.
-> Maintain and improve your project with new releases and generate changelogs. +> Лоиҳа ҳуд ро беҳбуд бибахшид ва он ро дар замон ҳоӣ мухталиф бароӣ корбарон мунташир кунид.
-> Do not let opened issues without response. Be nice with people that took time to open issues. 😉 +> Иҷоза надаҳид issue ҳоӣ боз дар github боқи бамонад, бо корбарон худ ба хуби рафтор кунид. 😉
-> 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). +> Як лоиҳа хуб ва солим лоиҳаӣ аст ки бо мушорикат сохта ва мушкилот он қодир ба ҳал шудан тавассут афрод дигар бошад. Бигзорид дигарон бидонанд шумо ба кумак онҳо ниёз дорид, митавонид бо `contribution welcome` ва `good first issue` дархост ҳоӣ худ ро дар github мунташир бихонид. [See github labels](https://help.github.com/en/articles/about-labels).
-> 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 thank them or showcase them on your project documentation or website. Here are some examples:
+> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [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 thank them or showcase them on your project documentation or website. Here are some examples:
>
> - [vuepress (contributors README section)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (random highlighted contributor on demo page)](https://okazari.github.io/Rythm.js/)
From a8318fb121e2ead4608f61a3bb7a88f75a9742b6 Mon Sep 17 00:00:00 2001
From: Niusha Pakseresht
-> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [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 thank them or showcase them on your project documentation or website. Here are some examples:
+> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [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 thank them or showcase them on your project documentation or website. Here are some examples:
>
> - [vuepress (contributors README section)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (random highlighted contributor on demo page)](https://okazari.github.io/Rythm.js/)
From ac363f9ed9053dc744583072733fa35299b5d17d Mon Sep 17 00:00:00 2001
From: Niusha Pakseresht
-> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [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 thank them or showcase them on your project documentation or website. Here are some examples:
+> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [gatsby](https://github.com/gatsbyjs/gatsby) ба мушорикат ҳои умуми ҷоӣза мидаҳанд. Агар қодир ба анҷом ин кор нистид, як пост мунташир кунид (дар твитер ио соӣр платформ ҳо) дар мурд мушорикат ва невисанда ([Як намуна сипосгузори аз мушорикат кунанда](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Як қисмат дар README лоҳа ба ном `Contributors` иҷод кунид ва ном он ҳо ро дар он қид кунид. Инҷо намуна ҳои муҷуд аст :
>
> - [vuepress (contributors README section)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (random highlighted contributor on demo page)](https://okazari.github.io/Rythm.js/)
From a3c133dabebd811fc5c37a9ae7810dc8988c7f69 Mon Sep 17 00:00:00 2001
From: Niusha Pakseresht 🏆 Ба мушорикат кунанда ҳо ҷоӣза даҳид
🏆 Ба мушорикат кунанда ҳо ҷоӣза даҳид
-> Github issues are not always the best way to communicate with your users. If necessary, you can use chat platforms to discuss with them:
+> Қисмат "Github issue" ҳамиша маҳали барой сапт бозҳурд ҳо нахоҳад буд. Шумо митавонид аз платформҳои зир барой ин кор истифода кунид:
>
> - [Discord](https://discordapp.com)
> - [Slack](https://slack.com)
From 38858406d0ab8ba2d8b750130926e9e1a13ace27 Mon Sep 17 00:00:00 2001
From: Niusha Pakseresht
-> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [gatsby](https://github.com/gatsbyjs/gatsby) ба мушорикат ҳои умуми ҷоӣза мидаҳанд. Агар қодир ба анҷом ин кор нистид, як пост мунташир кунид (дар твитер ио соӣр платформ ҳо) дар мурд мушорикат ва невисанда ([Як намуна сипосгузори аз мушорикат кунанда](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Як қисмат дар README лоҳа ба ном `Contributors` иҷод кунид ва ном он ҳо ро дар он қид кунид. Инҷо намуна ҳои муҷуд аст :
+> Хуб будан бо корбарон митавонад ба шумо кумак кунад ! бархи аз лоиҳаҳои матни боз монанд [gatsby](https://github.com/gatsbyjs/gatsby) ба мушорикат ҳои умуми ҷоӣза мидаҳанд. Агар қодир ба анҷом ин кор нистид, як пост мунташир кунид (дар твитер ио соӣр платформ ҳо) дар мурд мушорикат ва невисанда ([Як намуна сипосгузори аз мушорикат кунанда](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Як қисмат дар README лоиҳа ба ном `Contributors` иҷод кунид ва ном он ҳо ро дар он қид кунид. Инҷо намуна ҳои муҷуд аст :
>
> - [vuepress (contributors README section)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (random highlighted contributor on demo page)](https://okazari.github.io/Rythm.js/)
From e0d026b78b903024a147936a69882205d6ea7350 Mon Sep 17 00:00:00 2001
From: Niusha Pakseresht 🏆 Ба мушорикат кунанда ҳо ҷоӣза даҳид
-> User feedback is the best way to improve your project. They probably have features and ideas that could make your project better. +> Бозхурд корбарон ҳамиша беҳтарин роҳ барой беҳтар сози ва ҳал мушкилот барнома хоҳад буд, пас аз онҳо барой мушокират кумак бигирид ва аз он идее ҳой он ҳо истифода кунид.
-> Visitors will trust your project if they see concrete use cases and success stories, e.g., [the vuepress gallery](https://vuepress.gallery/)). +> Боздидкунандагон ба шумо иътимод биштари хоҳанд дошт агар намуна ҳой кор шумо ро тавасут сойр корбарон бибинанд : [the vuepress gallery](https://vuepress.gallery/)).