From 19470190ec38c293d832bfa204276119073dc82c Mon Sep 17 00:00:00 2001 From: "F. Rifat Hasan" Date: Sat, 30 Nov 2024 00:48:41 +0600 Subject: [PATCH] correct the lang: at the top of every file --- _articles/bn/best-practices.md | 34 ++--- _articles/bn/building-community.md | 26 ++-- _articles/bn/code-of-conduct.md | 26 ++-- _articles/bn/finding-users.md | 8 +- _articles/bn/getting-paid.md | 40 ++--- _articles/bn/how-to-contribute.md | 140 +++++++++--------- _articles/bn/leadership-and-governance.md | 20 +-- _articles/bn/legal.md | 40 ++--- ...ing-balance-for-open-source-maintainers.md | 46 +++--- _articles/bn/metrics.md | 44 +++--- _articles/bn/starting-a-project.md | 42 +++--- 11 files changed, 233 insertions(+), 233 deletions(-) diff --git a/_articles/bn/best-practices.md b/_articles/bn/best-practices.md index e842f33af14..1c77b72ac24 100644 --- a/_articles/bn/best-practices.md +++ b/_articles/bn/best-practices.md @@ -1,5 +1,5 @@ --- -lang: en +lang: bn title: Best Practices for Maintainers description: Making your life easier as an open source maintainer, from documenting processes to leveraging your community. class: best-practices @@ -60,10 +60,10 @@ If maintaining your project is part-time or purely volunteered, be honest about Here are a few rules that are worth writing down: -* How a contribution is reviewed and accepted (_Do they need tests? An issue template?_) -* The types of contributions you'll accept (_Do you only want help with a certain part of your code?_) -* When it's appropriate to follow up (_for example, "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_) -* How much time you spend on the project (_for example, "We only spend about 5 hours per week on this project"_) +- How a contribution is reviewed and accepted (_Do they need tests? An issue template?_) +- The types of contributions you'll accept (_Do you only want help with a certain part of your code?_) +- When it's appropriate to follow up (_for example, "You can expect a response from a maintainer within 7 days. If you haven't heard anything by then, feel free to ping the thread."_) +- How much time you spend on the project (_for example, "We only spend about 5 hours per week on this project"_) [Jekyll](https://github.com/jekyll/jekyll/tree/master/docs), [CocoaPods](https://github.com/CocoaPods/CocoaPods/wiki/Communication-&-Design-Rules), and [Homebrew](https://github.com/Homebrew/brew/blob/bbed7246bc5c5b7acb8c1d427d10b43e090dfd39/docs/Maintainers-Avoiding-Burnout.md) are several examples of projects with ground rules for maintainers and contributors. @@ -81,7 +81,7 @@ You've written things down. Ideally, everybody would read your documentation, bu Having everything written down, however, helps depersonalize situations when you do need to enforce your rules. -Saying no isn't fun, but _"Your contribution doesn't match this project's criteria"_ feels less personal than _"I don't like your contribution"_. +Saying no isn't fun, but _"Your contribution doesn't match this project's criteria"_ feels less personal than _"I don't like your contribution"_. Saying no applies to many situations you'll come across as a maintainer: feature requests that don't fit the scope, someone derailing a discussion, doing unnecessary work for others. @@ -111,10 +111,10 @@ Secondly, ignoring contributions sends a negative signal to your community. Cont If you don't want to accept a contribution: -* **Thank them** for their contribution -* **Explain why it doesn't fit** into the scope of the project, and offer clear suggestions for improvement, if you're able. Be kind, but firm. -* **Link to relevant documentation**, if you have it. If you notice repeated requests for things you don't want to accept, add them into your documentation to avoid repeating yourself. -* **Close the request** +- **Thank them** for their contribution +- **Explain why it doesn't fit** into the scope of the project, and offer clear suggestions for improvement, if you're able. Be kind, but firm. +- **Link to relevant documentation**, if you have it. If you notice repeated requests for things you don't want to accept, add them into your documentation to avoid repeating yourself. +- **Close the request** You shouldn't need more than 1-2 sentences to respond. For example, when a user of [celery](https://github.com/celery/celery/) reported a Windows-related error, @berkerpeksag [responded with](https://github.com/celery/celery/issues/3383): @@ -134,8 +134,8 @@ To reduce the volume of unwanted contributions in the first place, explain your If you're receiving too many low-quality contributions, require that contributors do a bit of work beforehand, for example: -* Fill out an issue or PR template/checklist -* Open an issue before submitting a PR +- Fill out an issue or PR template/checklist +- Open an issue before submitting a PR If they don't follow your rules, close the issue immediately and point to your documentation. @@ -233,11 +233,11 @@ The good news about maintaining a popular project is that other maintainers have There are a [variety of tools available](https://github.com/showcases/tools-for-open-source) to help automate some aspects of maintenance work. A few examples: -* [semantic-release](https://github.com/semantic-release/semantic-release) automates your releases -* [mention-bot](https://github.com/facebook/mention-bot) mentions potential reviewers for pull requests -* [Danger](https://github.com/danger/danger) helps automate code review -* [no-response](https://github.com/probot/no-response) closes issues where the author hasn't responded to a request for more information -* [dependabot](https://github.com/dependabot) checks your dependency files every day for outdated requirements and opens individual pull requests for any it finds +- [semantic-release](https://github.com/semantic-release/semantic-release) automates your releases +- [mention-bot](https://github.com/facebook/mention-bot) mentions potential reviewers for pull requests +- [Danger](https://github.com/danger/danger) helps automate code review +- [no-response](https://github.com/probot/no-response) closes issues where the author hasn't responded to a request for more information +- [dependabot](https://github.com/dependabot) checks your dependency files every day for outdated requirements and opens individual pull requests for any it finds For bug reports and other common contributions, GitHub has [Issue Templates and Pull Request Templates](https://github.com/blog/2111-issue-and-pull-request-templates), which you can create to streamline the communication you receive. @TalAter made a [Choose Your Own Adventure guide](https://www.talater.com/open-source-templates/#/) to help you write your issue and PR templates. diff --git a/_articles/bn/building-community.md b/_articles/bn/building-community.md index 90d73dd6eda..4931b3d171c 100644 --- a/_articles/bn/building-community.md +++ b/_articles/bn/building-community.md @@ -1,5 +1,5 @@ --- -lang: en +lang: bn title: Building Welcoming Communities description: Building a community that encourages people to use, contribute to, and evangelize your project. class: building @@ -26,16 +26,16 @@ As you build your community, consider how someone at the top of the funnel (a po Start with your documentation: -* **Make it easy for someone to use your project.** [A friendly README](../starting-a-project/#writing-a-readme) and clear code examples will make it easier for anyone who lands on your project to get started. -* **Clearly explain how to contribute**, using [your CONTRIBUTING file](../starting-a-project/#writing-your-contributing-guidelines) and keeping your issues up-to-date. -* **Good first issues**: To help new contributors get started, consider explicitly [labeling issues that are simple enough for beginners to tackle](https://help.github.com/en/articles/helping-new-contributors-find-your-project-with-labels). GitHub will then surface these issues in various places on the platform, increasing useful contributions, and reducing friction from users tackling issues that are too hard for their level. +- **Make it easy for someone to use your project.** [A friendly README](../starting-a-project/#writing-a-readme) and clear code examples will make it easier for anyone who lands on your project to get started. +- **Clearly explain how to contribute**, using [your CONTRIBUTING file](../starting-a-project/#writing-your-contributing-guidelines) and keeping your issues up-to-date. +- **Good first issues**: To help new contributors get started, consider explicitly [labeling issues that are simple enough for beginners to tackle](https://help.github.com/en/articles/helping-new-contributors-find-your-project-with-labels). GitHub will then surface these issues in various places on the platform, increasing useful contributions, and reducing friction from users tackling issues that are too hard for their level. [GitHub's 2017 Open Source Survey](http://opensourcesurvey.org/2017/) showed incomplete or confusing documentation is the biggest problem for open source users. Good documentation invites people to interact with your project. Eventually, someone will open an issue or pull request. Use these interactions as opportunities to move them down the funnel. -* **When someone new lands on your project, thank them for their interest!** It only takes one negative experience to make someone not want to come back. -* **Be responsive.** If you don't respond to their issue for a month, chances are, they've already forgotten about your project. -* **Be open-minded about the types of contributions you'll accept.** Many contributors start with a bug report or a small fix. There are [many ways to contribute](../how-to-contribute/#what-it-means-to-contribute) to a project. Let people help how they want to help. -* **If there's a contribution you disagree with,** thank them for their idea and [explain why](../best-practices/#learning-to-say-no) it doesn't fit into the scope of the project, linking to relevant documentation if you have it. +- **When someone new lands on your project, thank them for their interest!** It only takes one negative experience to make someone not want to come back. +- **Be responsive.** If you don't respond to their issue for a month, chances are, they've already forgotten about your project. +- **Be open-minded about the types of contributions you'll accept.** Many contributors start with a bug report or a small fix. There are [many ways to contribute](../how-to-contribute/#what-it-means-to-contribute) to a project. Let people help how they want to help. +- **If there's a contribution you disagree with,** thank them for their idea and [explain why](../best-practices/#learning-to-say-no) it doesn't fit into the scope of the project, linking to relevant documentation if you have it.