Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 18 additions & 41 deletions maintainer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ This guide is for people who would like to join the project as maintainers and h

This tutorial is also available in [other languages](translations/README.md).

| [English](maintainer_guide.md) | [Bangla](translations/maintainer_guide/maintainer_guide.ben.md) | [Chinese (Traditional)](/translations/maintainer_guide/maintainer_guide.zho-tc.md) | [French (française)](translations/maintainer_guide/maintainer_guide.fra.md) | [German](translations/maintainer_guide/maintainer_guide.ger.md) |
| :---: | :---: | :---: | :---: | :---: |
| [Hindi](translations/maintainer_guide/maintainer_guide.hin.md) | [Indonesian](translations/maintainer_guide/maintainer_guide.ind.md) | [Italian](translations/maintainer_guide/maintainer_guide.ita.md) | [Japanese](translations/maintainer_guide/maintainer_guide.jpn.md) | [Korean](translations/maintainer_guide/maintainer_guide.kor.md) |
| [Portuguese](translations/maintainer_guide/maintainer_guide.por.md) | [Russian](translations/maintainer_guide/maintainer_guide.rus.md) | [Ukrainian](/translations/maintainer_guide/maintainer_guide.ukr.md) |
> ⚠️ All translations below are currently outdated and describe the v1 workflow.

| [English](maintainer_guide.md) | [Bangla](translations/maintainer_guide/maintainer_guide.ben.md) | [Chinese (Traditional)](/translations/maintainer_guide/maintainer_guide.zho-tc.md) | [French (française)](translations/maintainer_guide/maintainer_guide.fra.md) | [German](translations/maintainer_guide/maintainer_guide.ger.md) |
| :-----------------------------------------------------------------: | :-----------------------------------------------------------------: | :--------------------------------------------------------------------------------: | :-------------------------------------------------------------------------: | :-------------------------------------------------------------: |
| [Hindi](translations/maintainer_guide/maintainer_guide.hin.md) | [Indonesian](translations/maintainer_guide/maintainer_guide.ind.md) | [Italian](translations/maintainer_guide/maintainer_guide.ita.md) | [Japanese](translations/maintainer_guide/maintainer_guide.jpn.md) | [Korean](translations/maintainer_guide/maintainer_guide.kor.md) |
| [Portuguese](translations/maintainer_guide/maintainer_guide.por.md) | [Russian](translations/maintainer_guide/maintainer_guide.rus.md) | [Ukrainian](/translations/maintainer_guide/maintainer_guide.ukr.md) |

> Translations for project documentation are welcome.
> Please read the [`Translation Guide`](translations/README.md) to contribute.
Expand All @@ -31,47 +33,22 @@ This is an active project that receives regular contributions and helps many peo

You can commit as much or as little time as you like. Together, we can keep the project running smoothly.

## Methodology

- Go to the project’s **Pull Requests** section and start with the oldest pull request that is not in the **changes requested** state.
- Open the pull request, go to the **Files changed** tab, and begin the code review.
- Review the PR and ensure it follows the specifications mentioned in the tutorial.
- Verify that the HTML, links, and data are correct. Ensure the card is positioned at the beginning of the file where required.
- Check for merge conflicts. If needed, merge the `master` branch into the PR branch to resolve them. Conflicts usually occur when the fork is outdated and multiple PRs modify similar sections.
- Resolve conflicts by adding the new card above cards that were added after the fork.
- If everything looks good, approve the PR and leave a message thanking the contributor for their work. Remember that many contributors are first-timers and benefit from encouragement.
- Merge the PR into `master`.

## Request changes

- Sometimes, there are issues in a pull request that should be fixed by the contributor, such as incorrect branching, broken HTML, missing information, or the card being placed in the wrong location. These cases occur when the tutorial was not followed correctly and are not simple merge conflicts.
- Start a code review on GitHub and request changes. Be as descriptive as possible—comment on the exact line, clearly explain what the problem is, how it can be fixed, and reassure the contributor that this is a normal part of the PR review process.
- Once you are ready, submit the review.
- Keep an eye on the discussion in case the contributor has follow-up questions you can help with. Our objective is to guide everyone to completion and support contributors throughout the process.
- After the requested changes are made, the pull request can be merged into `master`.
## v2 Workflow

Always test that the changes have not broken the project and that the live page still works as expected. It is best practice to test changes locally before merging and to never merge anything that looks suspicious.
The project now uses a fully automated pipeline for card submissions:

## Tools
**validate → automerge → archive**

If there are only a few pull requests, the entire review process can be handled directly on the project’s GitHub page.
However, it is common to have multiple pending PRs, which can lead to merge conflicts. You can use any tools you are comfortable with to review diffs and resolve conflicts.
### What maintainers do now:

A recommended tool is [GitKraken](https://www.gitkraken.com/download). It provides a visual interface and makes project management easier when handling multiple pull requests.
Download GitKraken, clone the project, and use it alongside your code editor. The integrated merge conflict tools give you full control to efficiently review PRs, resolve conflicts, and merge changes.
- Approve `ci.yml` workflows for flagged contributors
- Handle `Remove Card` requests via GitHub Actions
- Monitor the Actions tab for failed archive runs and re-trigger manually if needed

The project uses Prettier to ensure consistent formatting regardless of how contributors submit their PRs. This keeps the codebase consistent in terms of indentation and style.
If the HTML file looks unformatted, run the following command in the project root:

```js
npx prettier --write index.html
```

---
For archive operations, refer to [archive/README.md](archive/README.md).

## ✅ What to do now (final steps)
## Project Philosophy

- Paste this into the file
- **Commit message**:
`Improve clarity, grammar, and consistency in Maintainer Guide`
- **PR description**:
- **Contributors first** — every decision prioritizes the contributor experience
- **Minimum maintainability** — keep maintenance burden as low as possible
- **Simplicity** — no over-engineering
4 changes: 3 additions & 1 deletion translations/maintainer_guide/maintainer_guide.ben.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️ This translation is outdated. It describes the old v1 manual workflow. The project now uses automated validation and merging (v2). Please refer to the [English maintainer guide](../../maintainer_guide.md) for current instructions.

# পরিচালনা নির্দেশাবলি

যারা আমাদের প্রকল্প পরিচালনা ও বজায় রাখতে সহায়তা করতে প্রকল্পে রক্ষণাবেক্ষণকারী হিসাবে যোগদান করতে চান তাদের জন্য আমাদের এই পথ নির্দেশিকা। (দ্রষ্টব্যঃ এটি **নবীনদের** জন্য নয়।)
Expand All @@ -7,7 +9,7 @@
এই পৃষ্ঠাটি [অন্যোন্য ভাষায়ও](../README.md) অনুবাদ করা হয়েছে।

| [ইংরেজি](../../maintainer_guide.md) | [বাংলা](maintainer_guide.ben.md) | [জার্মানি](maintainer_guide.ger.md) | [ইটালিয়ান](maintainer_guide.ita.md) | [জাপানিজ](maintainer_guide.jpn.md) |
| :---: | :---: | :---: | :---: | :---: |
| :---------------------------------: | :------------------------------: | :---------------------------------: | :---------------------------------: | :--------------------------------: |
| [পর্তুগিজ](maintainer_guide.por.md) |

> আমাদের প্রকল্পের নথিগুলোর বিভিন্ন ভাষায় রুপান্তরকে আমরা আন্তরিকভাবে স্বাগত জানাই। অনুবাদ সম্বন্ধীয় অবদানের জন্যঃ [`অনুবাদ সহায়ক`](../README.md) -টি পরুন।
Expand Down
4 changes: 3 additions & 1 deletion translations/maintainer_guide/maintainer_guide.ell.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️ This translation is outdated. It describes the old v1 manual workflow. The project now uses automated validation and merging (v2). Please refer to the [English maintainer guide](../../maintainer_guide.md) for current instructions.

# Οδηγός Συντηρητή

Αυτός ο οδηγός είναι για όσους θέλουν να συμμετάσχουν στο έργο ως συντηρητές, για να βοηθήσουν στη διαχείριση και τη διατήρηση του έργου για την κοινότητα. (Αυτός δεν είναι ένας οδηγός για **τους συνεισφέροντες για πρώτη φορά**)
Expand Down Expand Up @@ -64,4 +66,4 @@ npx prettier --write index.html

Ελάτε μαζί μας για να βοηθήσουμε να αναπτύξουμε αυτό το έργο μαζί. Επικοινωνήστε μαζί μου στο [Twitter](https://twitter.com/Syknapse) και στείλτε μου το όνομα χρήστη σας στο GitHub για να σας προσθέσω. Μπορείτε επίσης να εγγραφείτε στην Κοινότητα Discord μας κάνοντας κλικ στο παρακάτω κουμπί:

[![Discord](https://badgen.net/discord/online-members/tWkvS4ueVF?label=Join%20Our%20Discord%20Server&icon=discord)](https://discord.gg/tWkvS4ueVF "Εγγραφείτε στο διακομιστή Discord μας !")
[![Discord](https://badgen.net/discord/online-members/tWkvS4ueVF?label=Join%20Our%20Discord%20Server&icon=discord)](https://discord.gg/tWkvS4ueVF 'Εγγραφείτε στο διακομιστή Discord μας !')
5 changes: 2 additions & 3 deletions translations/maintainer_guide/maintainer_guide.fra.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️ This translation is outdated. It describes the old v1 manual workflow. The project now uses automated validation and merging (v2). Please refer to the [English maintainer guide](../../maintainer_guide.md) for current instructions.

# Guide du responsable

Ce guide est destiné à ceux qui souhaitent rejoindre le projet en tant que responsables, pour aider à gérer et maintenir le projet pour la communauté. (Ceci n'est pas un guide pour les **contributeurs débutants**)
Expand Down Expand Up @@ -64,6 +66,3 @@ Si jamais vous avez des doutes, vous pouvez toujours me mentionner ou mentionner
Rejoignez-nous pour contribuer à faire grandir ce projet ensemble. Contactez-moi au [Twitter](https://twitter.com/Syknapse) et envoyez-moi votre nom d'utilisateur GitHub pour que je puisse vous ajouter. Vous pouvez également rejoindre notre communauté Discord en cliquant sur le bouton ci-dessous :

[![Discord](https://badgen.net/discord/online-members/tWkvS4ueVF?label=Join%20Our%20Discord%20Server&icon=discord)](https://discord.gg/tWkvS4ueVF 'Join our Discord server!')



9 changes: 6 additions & 3 deletions translations/maintainer_guide/maintainer_guide.ger.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️ This translation is outdated. It describes the old v1 manual workflow. The project now uses automated validation and merging (v2). Please refer to the [English maintainer guide](../../maintainer_guide.md) for current instructions.

# Leitfaden für Maintainer

Dieser Leitfaden richtet sich an diejenigen, die dem Projekt als Maintainer beitreten möchten, um die Verwaltung und Pflege des Projekts für die Community zu unterstützen. (Dies ist kein Leitfaden für **Erstbeiträger**)
Expand All @@ -6,9 +8,9 @@ Dieser Leitfaden richtet sich an diejenigen, die dem Projekt als Maintainer beit

Dieses Tutorial ist auch in [anderen Sprachen verfügbar](/translations/README.md)

| [Englisch](/maintainer_guide.md) | [Bengali](/translations/maintainer_guide/maintainer_guide.ben.md) | [Chinesische (Traditionell)](/translations/maintainer_guide/maintainer_guide.zho-tc.md) | [Deutsch](/translations/maintainer_guide/maintainer_guide.ger.md) | [Italienisch](/translations/maintainer_guide/maintainer_guide.ita.md) |
| :---: | :---: | :---: | :---: | :---: |
| [Japanisch](/translations/maintainer_guide/maintainer_guide.jpn.md) | [Portugiesisch](/translations/maintainer_guide/maintainer_guide.por.md) | [Ukrainisch](/translations/maintainer_guide/maintainer_guide.ukr.md) |
| [Englisch](/maintainer_guide.md) | [Bengali](/translations/maintainer_guide/maintainer_guide.ben.md) | [Chinesische (Traditionell)](/translations/maintainer_guide/maintainer_guide.zho-tc.md) | [Deutsch](/translations/maintainer_guide/maintainer_guide.ger.md) | [Italienisch](/translations/maintainer_guide/maintainer_guide.ita.md) |
| :-----------------------------------------------------------------: | :---------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :---------------------------------------------------------------: | :-------------------------------------------------------------------: |
| [Japanisch](/translations/maintainer_guide/maintainer_guide.jpn.md) | [Portugiesisch](/translations/maintainer_guide/maintainer_guide.por.md) | [Ukrainisch](/translations/maintainer_guide/maintainer_guide.ukr.md) |

> Übersetzungen für Projektdokumentationen sind willkommen. Lesen Sie den [`Übersetzungsleitfaden`](/translations/README.md), um beizutragen.

Expand Down Expand Up @@ -59,6 +61,7 @@ Falls Sie feststellen, dass die HTML-Datei unordentlich aussieht, führen Sie de
```js
npx prettier --write index.html
```

Es sollte versuchen, die Datei zu formatieren, und wenn es nicht kann, wird es Ihnen die Fehler anzeigen. Manchmal wird ein fehlendes schließendes Tag oder kaputtes HTML versehentlich gemergt, und dies ist eine gute Möglichkeit, es zu erkennen und zu beheben.

Wenn Sie jemals Zweifel haben, können Sie mich oder die anderen Maintainer jederzeit im PR selbst erwähnen oder mir eine DM auf [Twitter](https://twitter.com/Syknapse) senden.
Expand Down
11 changes: 7 additions & 4 deletions translations/maintainer_guide/maintainer_guide.hin.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
⚠️ This translation is outdated. It describes the old v1 manual workflow. The project now uses automated validation and merging (v2). Please refer to the [English maintainer guide](../../maintainer_guide.md) for current instructions.

# मेंटेनर मार्गदर्शिका

यह मार्गदर्शिका उन लोगों के लिए है जो समुदाय के हित में इस परियोजना के प्रबंधन और रखरखाव में योगदान देना चाहते हैं और मेंटेनर (Maintainer) के रूप में जुड़ना चाहते हैं।
Expand All @@ -9,9 +11,9 @@

यह ट्यूटोरियल [अन्य भाषाओं](../README.md) में भी उपलब्ध है।

| [अंग्रेज़ी](../../maintainer_guide.md) | [बांग्ला](/translations/maintainer_guide/maintainer_guide.ben.md) | [जर्मन](/translations/maintainer_guide/maintainer_guide.ger.md) | [इतालवी](/translations/maintainer_guide/maintainer_guide.ita.md) | [जापानी](/translations/maintainer_guide/maintainer_guide.jpn.md) |
| :---: | :---: | :---: | :---: | :---: |
| [हिंदी](maintainer_guide.hin.md) | [पुर्तगाली](/translations/maintainer_guide/maintainer_guide.por.md) | [यूक्रेनी](/translations/maintainer_guide/maintainer_guide.ukr.md) | [चीनी (पारंपरिक)](/translations/maintainer_guide/maintainer_guide.zho-tc.md) |
| [अंग्रेज़ी](../../maintainer_guide.md) | [बांग्ला](/translations/maintainer_guide/maintainer_guide.ben.md) | [जर्मन](/translations/maintainer_guide/maintainer_guide.ger.md) | [इतालवी](/translations/maintainer_guide/maintainer_guide.ita.md) | [जापानी](/translations/maintainer_guide/maintainer_guide.jpn.md) |
| :------------------------------------: | :-----------------------------------------------------------------: | :----------------------------------------------------------------: | :--------------------------------------------------------------------------: | :--------------------------------------------------------------: |
| [हिंदी](maintainer_guide.hin.md) | [पुर्तगाली](/translations/maintainer_guide/maintainer_guide.por.md) | [यूक्रेनी](/translations/maintainer_guide/maintainer_guide.ukr.md) | [चीनी (पारंपरिक)](/translations/maintainer_guide/maintainer_guide.zho-tc.md) |

> परियोजना के दस्तावेज़ों के अनुवाद का स्वागत है।
> योगदान करने के लिए कृपया [`अनुवाद मार्गदर्शिका`](../README.md) पढ़ें।
Expand Down Expand Up @@ -95,4 +97,5 @@ GitKraken डाउनलोड करें, परियोजना क्ल
यदि HTML फ़ाइल असंगठित दिखे, तो प्रोजेक्ट रूट में निम्न कमांड चलाएँ:

```js
npx prettier --write index.html
npx prettier --write index.html
```
Loading