Skip to content

Commit

Permalink
Fix test failures
Browse files Browse the repository at this point in the history
- Markdown style wants `*` not `-` for lists
- Removed some extra blank lines
- The `retext-repeated-words` plugin has only a small list of
  words that are allowed to be repeated, but pidgin uses doubled
  words as intensifiers ("small small" for "very small"). I added
  hyphens ("small-small") because I saw some examples of that
- Renamed the `best-practice.md` -> `best-practices.md` to match
  the rest of the site
- Copied the untranslated articles in so the site build works
  • Loading branch information
ahpook committed Jan 13, 2024
1 parent 0a40a96 commit bbd67b2
Show file tree
Hide file tree
Showing 10 changed files with 1,746 additions and 24 deletions.
20 changes: 10 additions & 10 deletions _articles/pcm/best-practice.md → _articles/pcm/best-practices.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
lang: pidgin
lang: pcm
title: Best Practices for Maintainers
description: Learn how to make your life easy as an open source maintainer, from documentation to community collaboration. Make sense of maintaining open source projects with these top-notch tips.
class: best-practices
Expand Down Expand Up @@ -42,16 +42,16 @@ As @lord don talk, project vision fit help you know wetin you go fit work on. As

E fit hard you to write down rules. Sometimes you fit think say you dey police people or say you dey dull dem vibe.

But if you write rules fairly and you dey follow am, e go empower you. E go prevent you from doing tins wey you no like. People wey see your project fit no sabi your condition or circumstances. Dem fit think say dem dey pay you for the work wey you dey do, especially if na wetin dem dey use well well. Dem fit even think say you dey busy with new work or family matter.
But if you write rules fairly and you dey follow am, e go empower you. E go prevent you from doing tins wey you no like. People wey see your project fit no sabi your condition or circumstances. Dem fit think say dem dey pay you for the work wey you dey do, especially if na wetin dem dey use well-well. Dem fit even think say you dey busy with new work or family matter.

E good make people sabi dis tins.

If to maintain your project na part-time or you dey do am because you volunteer, make you talk the time wey you get. E no be say na the time wey your project need or wetin people dey ask you for, na the time wey you get na e you go talk. E fit good if you write down some rules like:

- How dem go review contribution (dem need test? Issue template?)
- The kind of contribution wey dem go accept (you wan make dem help you with specific part of your code?)
- When e go make sense for dem to follow up (e.g., "you fit expect response from maintainer within 7 days, if you no see any response by then, you fit ping the thread")
- How much time you dey spend for the project (e.g., "we dey spend like 5 hours per week on this project")
* How dem go review contribution (dem need test? Issue template?)
* The kind of contribution wey dem go accept (you wan make dem help you with specific part of your code?)
* When e go make sense for dem to follow up (e.g., "you fit expect response from maintainer within 7 days, if you no see any response by then, you fit ping the thread")
* How much time you dey spend for the project (e.g., "we dey spend like 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) na some examples of projects wey get rules for maintainers and contributors.

Expand All @@ -65,7 +65,7 @@ If you meet other maintainers or you take big decision for private, write the co

You don write down wetin you want, but people never read your documentation well. Sometimes you go still remind them say knowledge dey your documentation.

Saying no no dey fun, but make you try yarn "Your contribution no dey follow this project criteria" e no too personal like "I no like your contribution."
Saying "no" no dey fun, but make you try yarn "Your contribution no dey follow this project criteria" e no too personal like "I no like your contribution."

You go fit yarn no for plenty situations wey you go see as maintainer like feature requests wey no follow your project plan or person wey dey disturb discussion.

Expand All @@ -89,7 +89,7 @@ If you come across one contribution wey you no wan accept, your first reaction f

No just allow one contribution wey you no want dey open because you dey feel bad or you dey try to dey nice. As time dey go, the issues and PRs wey you never answer go make your project come dey feel like say e too stress you and dey intimidate you.

E better make you quick-close contributions wey you sabi say you no wan accept am. If your project don already gather plenti matter wey never resolve, @steveklabnik get some advice on [how to quickly arrange the issues] so e go dey efficient. (https://words.steveklabnik.com/how-to-be-an-open-source-gardener).
E better make you quick-close contributions wey you sabi say you no wan accept am. If your project don already gather plenti matter wey never resolve, @steveklabnik get some advice on [how to quickly arrange the issues](https://words.steveklabnik.com/how-to-be-an-open-source-gardener) so e go dey efficient.

If you no wan accept one contribution:

Expand Down Expand Up @@ -245,7 +245,7 @@ Just like any other work, make you dey take regular breaks so you go dey refresh
<img src="https://avatars.githubusercontent.com/danielbachhuber?s=180" class="pquote-avatar" alt="avatar">
In maintaining WP-CLI, I've discovered I need to make myself happy first, and set clear boundaries on my involvement. The best balance I've found is 2-5 hours per week, as a part of my normal work schedule. This keeps my involvement a passion, and from feeling too much like work. Because I prioritize the issues I'm working on, I can make regular progress on what I think is most important.
<p markdown="1" class="pquote-credit">
@danielbachhuber, ["My condolences, you're now the maintainer of a popular open source project"](https://web.archive.org/web/20220306014037/https/danielbachhuber.com/2016/06/26/my-condolences-youre-now-the-maintainer-of-a-popular-open-source-project/)
@danielbachhuber, ["My condolences, you're now the maintainer of a popular open source project"](https://web.archive.org/web/20220306014037/https://danielbachhuber.com/2016/06/26/my-condolences-youre-now-the-maintainer-of-a-popular-open-source-project/)
</p>
</aside>

Expand All @@ -257,4 +257,4 @@ Taking breaks no only apply to vacations, e fit include say you no wan do open s

## Make you dey take care of yourself first!

To maintaining one popular project require different skills from the first first time of growth, but e no dey less rewarding. As one maintainer, you go dey practice leadership and personal skills for one level wey few people fit experience. Though e no dey easy to manage, setting clear boundaries and only taking on wetin you dey comfortable with go help you dey happy, refreshed, and productive.
To maintaining one popular project require different skills from the first-first time of growth, but e no dey less rewarding. As one maintainer, you go dey practice leadership and personal skills for one level wey few people fit experience. Though e no dey easy to manage, setting clear boundaries and only taking on wetin you dey comfortable with go help you dey happy, refreshed, and productive.
4 changes: 1 addition & 3 deletions _articles/pcm/building-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ You no go fit talk with most people wey go show for your project. Some people fi

<aside markdown="1" class="pquote">
<img src="https://avatars.githubusercontent.com/sagesharp?s=180" class="pquote-avatar" alt="avatar">
Una leaders go get different opinions, as all healthy communities should! The thing be say, you gas take steps to make sure the loudest voice no dey always win by tiring people out, and that small small voices for our midst, we dey hear am.
Una leaders go get different opinions, as all healthy communities should! The thing be say, you gas take steps to make sure the loudest voice no dey always win by tiring people out, and that small-small voices for our midst, we dey hear am.
<p markdown="1" class="pquote-credit">
@sagesharp, ["Wetin makes a good community?"](https://sage.thesharps.us/2015/10/06/what-makes-a-good-community/)
</p>
Expand Down Expand Up @@ -191,7 +191,6 @@ Make your head nor dey hot e nor easy, but as you set good example, e go make yo

Your README [no be only set of instructions](../starting-a-project/#writing-a-readme). E also na place to yan about your goals, product vision, and roadmap. If people dey focus too much on top argument about one particular feature, e fit help if you go back your README, talk about the higher vision of your project. To focus on your README go even make the matter no dey personal, so that you go fit yan-kick with sense.


### Make we focus for the journey, nor be the destination

Some projects dey use voting process to take make major decisions. E fit look sensible for eye at first, but voting dey show say them dey find 'answer,' instead of say them dey listen to each other concerns.
Expand Down Expand Up @@ -236,7 +235,6 @@ If the talk clear nor dey waka, e nor get clear action to take, or the right act
</p>
</aside>


### Choose your battles with sense

Context dey important. Think about the people wey dey the discussion and how them represent the rest of the community.
Expand Down
22 changes: 11 additions & 11 deletions _articles/pcm/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Make you try your best to arrange code of conduct early, if you fit, ideally whe

Apart from just communicating your expectations, code of conduct fit describe the following:

- Where the code of conduct dey apply _(only on issues and pull requests, or community activities like events?)_
- Whom the code of conduct dey apply to _(community members and maintainers, but what about sponsors?)_
- Wetin go happen if person violate the code of conduct
- How person fit report violations
* Where the code of conduct dey apply _(only on issues and pull requests, or community activities like events?)_
* Whom the code of conduct dey apply to _(community members and maintainers, but what about sponsors?)_
* Wetin go happen if person violate the code of conduct
* How person fit report violations

Anywhere way you fit, try to use previous example. The [Contributor Covenant](https://contributor-covenant.org/) na code of conduct wey many open source projects, including Kubernetes, Rails, and Swift, don use, and e fit serve as example.

Expand All @@ -46,11 +46,11 @@ Put one CODE_OF_CONDUCT file for your project's main directory, and make sure sa

You suppose explain how you go enforce your code of conduct **_before_** person violate am. Some reasons why you suppose do am be say:

- E show say you dey serious about action when e dey necessary.
* E show say you dey serious about action when e dey necessary.

- Your community go dey reassured say complaints go dey reviewed.
* Your community go dey reassured say complaints go dey reviewed.

- You go reassure your community say the review process go dey fair and transparent, if at any time dem dey investigated for violation.
* You go reassure your community say the review process go dey fair and transparent, if at any time dem dey investigated for violation.

You suppose give people private way (like email address) to report code of conduct violation and explain who go receive that report. E fit be maintainer, group of maintainers, or code of conduct working group.

Expand Down Expand Up @@ -87,15 +87,15 @@ If person report say somebody violate the code of conduct, e na you suppose hand

You fit respond to code of conduct violation for different ways:

- **Warn the person wey dey involved publicly** and explain how their behavior affect others, preferably for the place where e happen. If possible, public communication go show the rest of the community say you dey serious about the code of conduct. Make you dey kind but firm for your communication.
* **Warn the person wey dey involved publicly** and explain how their behavior affect others, preferably for the place where e happen. If possible, public communication go show the rest of the community say you dey serious about the code of conduct. Make you dey kind but firm for your communication.

- **Privately reach out to the person** wey dey involved to explain how their behavior affect others. You fit use private communication channel if the situation get sensitive personal information. If you communicate privately with person, e good make you CC those wey first report the situation, so dem go know say you don take action. Ask the person wey report make e agree before you CC am.
* **Privately reach out to the person** wey dey involved to explain how their behavior affect others. You fit use private communication channel if the situation get sensitive personal information. If you communicate privately with person, e good make you CC those wey first report the situation, so dem go know say you don take action. Ask the person wey report make e agree before you CC am.

Sometimes, you fit no fit resolve the matter. The person wey dey involved fit dey aggressive or hostile when you confront am, or e no fit change their behavior. For this kind situation, you fit consider stronger action. For example:

- **Suspend the person** wey dey involved for the project, you go enforce am through temporary ban wey go stop am from participating for any aspect of the project.
* **Suspend the person** wey dey involved for the project, you go enforce am through temporary ban wey go stop am from participating for any aspect of the project.

- **Permanently ban** the person from the project.
* **Permanently ban** the person from the project.

Make you no take banning members lightly, e be like say e be something wey no fit change and no fit reconcile different perspectives. You suppose only take these measures if e clear say you no fit resolve the matter.

Expand Down
Loading

0 comments on commit bbd67b2

Please sign in to comment.