28 KiB
Das offizielle freeCodeCamp Moderator Handbuch
Dieses Handbuch hilft dir, verschiedene Orte in unserer Community zu moderieren. This covers conversations and interactions in issues and pull request threads on GitHub, the community forum, the chat rooms, and other official communities that we foster.
[!NOTE] Alle freeCodeCamp-Moderatoren sind Community-weite Moderatoren. That means we trust you to oversee any of these places.
Du kannst auf jeder der Plattformen, die dich am meisten interessieren, als Moderator/in tätig sein. Einige Moderatoren helfen nur auf GitHub, während andere nur im Forum helfen. Einige Moderatoren sind überall aktiv.
Unterm Strich wollen wir, dass es dir Spaß macht, Moderator/in zu sein, und dass du deine knappe Zeit in Dinge investierst, die dich interessieren.
"Mit großer Macht kommt große Verantwortung" - Uncle Ben
Als Moderator/in ist das Temperament wichtiger als die technischen Fähigkeiten.
Hör zu. Be helpful. Missbrauche deine Macht nicht.
Das freeCodeCamp ist eine inklusive Community, und das soll auch so bleiben.
We have a single Code of Conduct that governs our entire community. Je weniger Regeln, desto einfacher ist es, sich sie zu merken. Du kannst die Regeln hier lesen und sie dir einprägen.
[!NOTE] As a moderator, we would add you to one or more teams on GitHub, our community forums & chat servers. If you are missing access to a platform that you would like to moderate, please reach out to a staff member.
GitHub moderieren
Auf GitHub haben Moderatoren zwei Hauptaufgaben:
- Triaging and responding to issues.
- Reviewing and merging pull requests (aka QA).
GitHub Issues moderieren
We use our main freeCodeCamp/freeCodeCamp repository as a common issue tracker for all of our repositories. We get new issues every day, all of which need to be triaged, labeled, and addressed. Das ist auch ein guter Ort, um mit Beiträgen zur Open-Source-Codebasis anzufangen.
Triage von Issues
Triaging ist ein Prozess, bei dem die Aufmerksamkeit für jeden neuen Issue Report priorisiert wird. Wir haben eine umfangreiche Liste von Labels, die wir verwenden, um die Priorität, Kategorie, Status und Umfang jedes Problems zu kennzeichnen.
Du kannst uns helfen, die Issues zu ordnen und einzuteilen, indem du Labels aus dieser Liste anwendest. Normalerweise ist neben dem Label eine Beschreibung verfügbar, in der die Bedeutung erläutert wird.
Bitte achte besonders auf die Label "help wanted" und "first timers only". Diese sollen zu Threads hinzugefügt werden, von denen du denkst, dass sie für potenzielle Mitwirkende geöffnet werden können, um einen Pull-Request zu erstellen.
For triaging a trivial issue such as a typo fix, it is recommended to apply a "first timers only" label along with additional information. You can utilize the reply template provided for this purpose.
Schließen veralteter, inaktiver Issues und Pull-Requests
-
Veraltete Issues oder PRs sind solche, die seit 21 Tagen (3 Wochen nach der letzten Aktivität) keine Aktivität vom Autor erfahren haben, aber erst nachdem ein Moderator weitere Informationen/Änderungen angefordert hat.
-
Activity is defined as: Comments requesting an update on the PR and triages like
status: update neededlabel, etc. -
Wenn der Beitragende um zusätzliche Hilfe oder sogar Zeit bittet, kann das oben Gesagte gelockert und nach einer Antwort erneut überprüft werden. In jedem Fall sollten die Moderatoren nach bestem Wissen und Gewissen den Status der ausstehenden PR klären.
[!TIP] We recommend you use this list of standard reply templates while triaging issues.
Pull-Requests moderieren
Pull Requests (PRs) sind die Art und Weise, wie Mitwirkende Änderungen an das freeCodeCamp-Repository übermitteln. Wir müssen eine Qualitätssicherung (QA) für Pull-Requests durchführen, bevor wir entscheiden, ob wir sie zusammenführen, Änderungen beantragen oder schließen.
Arten von Pull Requests
-
Challenge instruction edits
These are changes to the text of challenges - the description, instructions, or test text.
Du kannst sie auch direkt auf GitHub überprüfen und entscheiden, ob du sie zusammenführen möchtest. Wir müssen hier etwas vorsichtiger sein, denn Millionen von Menschen werden diesem Text begegnen, wenn sie den freeCodeCamp-Studienplan durcharbeiten. Macht der Pull-Request den Text klarer, ohne ihn viel länger zu machen? Sind die Änderungen relevant und nicht übermäßig pedantisch? Denke daran, dass unser Ziel ist, dass die Aufgaben so deutlich und so kurz wie möglich sind. Sie sind nicht der Ort für unklare Details. Die Mitwirkenden könnten versuchen, Links zu Ressourcen zu den Aufgaben hinzuzufügen.
You can close invalid pull requests and reply to them with these reply templates.
If the changes look good, please ensure to leave an approval with a "LGTM" (Looks Good To Me) comment. Sobald ein Pull Request mindestens zwei Genehmigungen (einschließlich deiner) von den Moderatoren oder dem Entwicklungsteam erhält, kannst du ihn zusammenführen.
-
Challenge code edits
These are changes to the code in a challenge - the challenge seed, challenge solution, and test strings.
These pull requests need to be pulled down from GitHub and tested on your local computer or Gitpod to make sure the challenge tests can still be passed with the current solution and to make sure the new code doesn't introduce any errors.
Einige Mitwirkende werden versuchen, zusätzliche Tests hinzuzufügen, um spitzfindige Sonderfälle abzudecken. Wir müssen aufpassen, dass wir die Aufgabe nicht zu kompliziert machen. Diese Aufgaben und ihre Tests sollten so einfach und intuitiv wie möglich sein. Abgesehen von den Algorithmusaufgaben und dem Abschnitt zur Interviewvorbereitung sollten die Teilnehmer/innen in der Lage sein, jede Aufgabe innerhalb von etwa 2 Minuten zu lösen.
You can close invalid pull requests and reply to them with these reply templates.
If the changes look good, please ensure to leave an approval with an "LGTM" comment. Sobald ein Pull-Request mindestens zwei Genehmigungen (einschließlich deiner) von den Moderatoren oder dem Entwicklungsteam erhält, kannst du ihn zusammenführen.
-
Platform changes
Diese Code-Bearbeitungen ändern die Funktionalität der freeCodeCamp-Plattform selbst.
Manchmal versuchen Mitwirkende, Änderungen ohne große Erklärungen vorzunehmen, aber bei Codeänderungen müssen wir sicherstellen, dass es einen echten Bedarf für die Änderung gibt. Diese Pull-Requests sollten auf ein bestehendes GitHub Issue verweisen, in dem die Gründe für die Änderung erläutert werden. Dann kannst du die Pull-Request auf deinem Computer öffnen und sie lokal testen.
Wenn du das getan hast und die Änderungen gut aussehen, solltest du sie noch nicht zusammenführen. Du kannst den Pull-Request mit "LGTM" kommentieren und dann "@freeCodeCamp/dev-team" erwähnen, damit sie einen letzten Blick darauf werfen können.
-
Automatisierte PRs (Dependabot)
Einige PRs sind automatische Aktualisierungen von Abhängigkeiten, die über eine Integration vorgenommen werden. Du solltest diese PRs nicht zusammenführen oder genehmigen. Ein Mitglied des Entwicklerteams kümmert sich um die Überprüfung und Zusammenführung solcher automatischen PRs.
How to Review, Merge, or Close Pull Requests
Assign yourself to a Pull Request:
Wenn du einen Pull-Request zum Überprüfen auswählst, solltest du dich diesem zunächst selbst zuweisen. Du kannst dies tun, indem du in der rechten Spalte der GitHub-Benutzeroberfläche auf den Link "assign yourself" unter dem Bereich "assignees" klickst.
Je nachdem, um welche Art von Pull-Request es sich handelt, befolge die entsprechenden Regeln, die zuvor aufgelistet wurden.
Ensure the CI Checks are Passing:
Vergewissere dich vor dem Zusammenführen eines Pull Requests, dass GitHub alle Prüfungen für die Pull-Requests als bestanden meldet (grüne Häkchen). Wenn du feststellst, dass eine der Prüfungen fehlschlägt, untersuche bitte die Ursache und kläre sie. Führt die Änderung dazu, dass unsere Tests nicht mehr funktionieren? Wird die Seite korrekt aufgebaut, wenn der PR zusammengeführt wird? Diese Kontrollen sind entscheidend für die Stabilität der Plattform.
[!WARNING] Das Zusammenführen eines PRs, der die CI/CD-Prüfungen nicht besteht, kann für alle Beteiligten, einschließlich des Entwicklungsteams und der Mitwirkenden, zu Schwierigkeiten führen.
Handling Merge Conflicts:
Sometimes there will be a merge conflict.
Das bedeutet, dass ein anderer Pull-Request eine Änderung an demselben Teil der Datei vorgenommen hat. GitHub hat ein Tool, mit dem du diese Merge-Konflikte direkt auf GitHub lösen kannst. Du kannst versuchen, diese Konflikte zu lösen. Use your best judgment.
Die Änderungen des Pull-Requests stehen oben und die des main-Branch unten. Manchmal gibt es dort überflüssige Informationen, die gelöscht werden können. Bevor du fertig bist, stelle sicher, dass du die <<<<<, ====== und >>>>>> löschst, die Git hinzufügt, um Merge-Konflikte anzuzeigen.
Wenn du dir unsicher bist, frag bitte einen der anderen Moderatoren oder das Entwicklerteam um Hilfe.
Merging a Valid Pull Request:
Wenn der Pull-Request so aussieht, dass er zusammengeführt werden kann (und keine weiteren Genehmigungen benötigt - denk daran, dass wir mindestens zwei benötigen), kannst du ihn zusammenführen. Achte darauf, dass du die Standardoption "Squash and Merge" verwendest. Dadurch werden alle Pull-Request-Commits zu einem einzigen Commit zusammengefasst, wodurch die Git-Historie viel einfacher zu lesen ist.
You should then comment on the pull request, thanking the contributor in your own personal way!
Wenn der Autor des Pull-Requests zum ersten Mal beiträgt, solltest du ihm auch zu seinem ersten zusammengefassten Pull-Request für das Repository gratulieren. Du kannst in der oberen rechten Ecke des PR-Body nachsehen, ob es sich um einen "first-time" Mitwirkenden handelt. Es wird First-time contributor angezeigt, wie unten dargestellt:
Wenn der Pull-Request nicht bereit zum Zusammenführen zu sein scheint, kannst du dem Autor höflich antworten und ihm sagen, was er tun sollte, um ihn fertigzustellen. Wir hoffen, dass sie antworten und ihr Pull-Request bald fertig ist.
Wenn du eine zweite Meinung zu einem Pull-Request benötigst, hinterlasse deine Kommentare zu dem Pull-Request und füge dann das Label "discussing" zu dem Pull-Request hinzu.
Closing an Invalid Pull Request:
Oft ist ein Pull-Request mit wenig Aufwand verbunden. You can usually tell this immediately when the contributor didn't bother checking the checkboxes in the Pull Request Template or used a generic pull request title like "Made changes" or "Update index.md".
Es gibt auch Situationen, in denen der/die Mitwirkende versucht, einen Link zu seiner/ihrer Website hinzuzufügen, eine von ihm/ihr erstellte Bibliothek einzubinden oder eine unseriöse Bearbeitung vorzunehmen, die niemandem außer ihm/ihr selbst hilft.
You can close these invalid pull requests and reply to them with these reply templates.
Filtering Pull Requests
To sort Pull Requests for Quality Assurance for quick access to PRs that are ready for review, do not have a merge conflict, are not blocked, and have all status checks in green, use the following link to apply the filters:
Direct link with filter applied
Other Guidelines for Moderators on GitHub
Though you will have write access to freeCodeCamp's repository, you should never push code directly to freeCodeCamp repositories. All code should enter freeCodeCamp's codebase in the form of a pull request from a fork of the repository.
Also, you should never accept your own PRs. They must be reviewed by another moderator, just like any other PR.
If you notice anyone breaking the Code of Conduct on GitHub issues, or opening pull requests with malicious content or code, email support[at]freecodecamp.org with a link to the offending pull request, and we can consider banning them from freeCodeCamp's GitHub organization entirely.
Das Forum moderieren
As a moderator, you help keep our community an enjoyable place for anyone to learn and get help. You will deal with flagged posts and handle spam, off-topic, and other inappropriate conversations.
Note that once you are a moderator on the forum, you will start to see blue moderator hints about forum members, like "this is the first time [person] has posted - let's welcome them to the community!" or "[person] hasn't posted in a long time - let's welcome them back."
These are opportunities for you to welcome them and make them feel extra special. You never know which person who's marginally involved may become our next super-helper, helping many other people in their coding journey. Even the slightest kindness may trigger a cascade of good deeds.
Deleting Forum Posts
Forum moderators can delete users' posts. You should only do this for the following instances:
- Jemand hat ein pornografisches oder grafisch gewalttätiges Bild gepostet.
- Jemand hat einen Link oder Code gepostet, der bösartig ist und anderen Teilnehmern, die darauf klicken, schaden könnte.
- Someone has flooded a thread with a lot of spam messages.
- An account has been created, beyond a reasonable doubt, to spam.
Dealing with Spam
For the first spam post of a legitimate user (ie. whose intent isn't to spam the forum but to learn/contribute to the forum), send them a message explaining the problem, and remove the link or post as appropriate. Leave a note on the user's profile explaining the action you have taken. If the problem persists, then quietly block the user from posting (using the silence option on the User Admin panel). Send the user a warning with the Code of Conduct. Check the box in the private message indicating that your message is a "formal warning."
As a moderator, you can ask questions and report incidents in the mod-team forum section.
Dealing with Off-Topic Conversations
Posts or topics that seem to be in the wrong place can be recategorized or renamed to whatever would be appropriate.
In exceptional circumstances, it may be appropriate for a moderator to fork a discussion into multiple threads.
Again, if you have any problems or questions, make a post with your actions in the "Staff" category, and tag another moderator if you want them to review your moderating actions.
Dealing with Posted Solutions
If a user replies in a help thread for the freeCodeCamp curriculum with a solution, remove it and use the Solution Instead of Help canned reply (or a similar response in your own words).
If the OP (Original Poster) replies within a freeCodeCamp curriculum help thread with their final solution, blur it, and use the Blurred Spoiler Solution canned reply.
If a user creates a thread asking for feedback on a solution, move the thread to the feedback subforum and blur the solution, as necessary. If the user is only posting the solution to show it off, then unlist the thread and use the Solutions Thread canned reply.
Underage Users
Our Terms of Service require that freeCodeCamp users be at least 13 years of age. If a user reveals that they are under the age of 13, send them the message below, suspend their account, then email the link of their forum account to support[at]freecodecamp.org for their freeCodeCamp /learn and forum accounts removal.
SUBJECT: Users under 13 are not allowed to use the forum per our Terms of Service.
It has come to our attention that you are under 13 years of age. Per the [freeCodeCamp Terms of Service](https://freecodecamp.org/terms), you must be at least 13 years old to use the site or the forum. We will be deleting both your freeCodeCamp account and your forum account. This restriction keeps us in compliance with United States laws.
Please rejoin once you have reached at least 13 years of age.
Thank you for understanding.
Account Deletion Requests
If a user requests their account to be deleted, send the following:
Deleting an account with many posts disrupts the flow of conversation, and could remove helpful information for other Campers.
We can anonymize your account, which will remove your username along with any other public information associated with your forum account. Your posts will remain, but will be attributed to an anonymous user, and you will be unable to log in to the account, as it will no longer be associated with an email address.
If you would like to proceed with this, please reply to this message with your consent.
If a user insists on having their account deleted, ask them to email support[at]freecodecamp.org with a link to their forum account.
Moderating Via Cell Phone
Moderating the forum is possible via a cell phone but you may encounter some usage quirks. This is not an exhaustive list.
- When trying to include a "Canned reply" in a response, if the menu doesn't open (after clicking on the gear), click on the text area first then try it again.
- The moderator's 'wrench' is at the bottom of the view-port but if you click it and cannot see the "Select Posts" button because it has scrolled out of view, you may need to try to scroll to it, though sometimes that doesn't work in which case moving to a desktop/laptop monitor may be needed.
- Sometimes clicking on the three-dot menu below a post can hide the reply icon. Reload the page to get it back.
Facebook moderieren
If you see anything that seems to break our Code of Conduct, you should delete it immediately.
Sometimes people will post things that they think are funny. They don't realize that what they said or what they shared could be interpreted as offensive. You should delete such posts, but not necessarily ban the person. Hopefully, the user will come to understand that what they posted was inappropriate because the post was deleted.
But if it is an egregious offense that can't reasonably be attributed to a cultural difference or a misunderstanding of the English language. In that case, you should strongly consider blocking the member from the Facebook group.
Moderating Discord
Here's how moderators deal with violations of our Code of Conduct on our chat server:
[!NOTE] Camperbot serves as our moderation bot, and all of the commands use Discord's native slash command interface. You can see a list of all of the commands by typing
/in any channel.
-
Make sure the user intended to violate the Code of Conduct.
Not all violations of the Code of Conduct were intended as such. A new camper might post a large amount of code for help, unaware that this can be disruptive to the conversation. In diesen Fällen kannst du sie einfach bitten, ihren Code mit Diensten wie CodePen oder Pastebin einzufügen.
-
If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:
For minor offences, a warning may be issued with the
/warncommand. For more egregious offences, you can remove the member from the server temporarily with the/kickcommand, or permanently with the/bancommand. In some cases, a member may just need some time to cool off and collect their thoughts - the/mutecommand allows you to prevent them from engaging with our community for a set period of time. A muted member can see the conversation, but cannot post messages or add reactions.All moderation commands will take a
reasonparameter, which should be a short explanation of why the action was taken. Moderation actions done with the bot will be logged in#mod-actions, which allows us all to stay on the same page. As such, we should avoid using Discord's built-in moderation tools, as they will not be logged.[!WARNING] The reason provided to a moderation command will also be included in the DM notification to the camper. Please remember to be professional here.
-
Creating a private discussion
Es kann Situationen geben, in denen du ein Anliegen mit einem Teilnehmer unter vier Augen besprechen musst. Dies sollte nicht über DMs geschehen, da dies zu Situationen führen kann, in denen du eine Sache behauptest und der Teilnehmer eine andere. Nutze stattdessen die Funktionen des Bots, um eine private Diskussion zu führen:
- Call the
/privatecommand, wheretargetis the camper you want to open a private channel with. - The bot will create a new channel, and add the mentioned camper and all moderators with the
Your Friendly Moderatorrole. While all moderators are added to the channel for transparency, the moderator who calls this command should be the only one to interact with the camper unless they request assistance. - When the conversation is complete, click the
❌ Closebutton on the first message in the private channel to have the bot close and delete that channel.
- Call the
-
Deleting messages
Our moderation bot is configured to log deleted messages automatically in the
#mod-actionschannel. If a message is not in line with our Code of Conduct, or otherwise not appropriate for our community, you are generally safe to delete it.Note that if the message contains content that violates Discord's terms of service, you'll want to report it via https://dis.gd/report prior to deleting it.
-
Don’t threaten to take action
If a camper breaks the Code of Conduct, don’t threaten to take moderator action, and never warn them in public. Instead, talk to them privately using the bot's
/privatecommand, or use the bot's moderation commands.If a violation was clearly unintended and doesn't warrant moderation action or private conversation, make the offending camper aware of their actions without making it come across as a warning.
For example:
-
Camper posts a wall of code to request help:
Moderator: @username Please use CodePen or Pastebin when posting large amounts of code.
-
Or if you really have to explain why:
Moderator: @username Please use CodePen or Pastebin when posting large amounts of code, because it disrupts the chat for everyone and could be considered spamming according to our Code of Conduct.
-
For mild and unintentional violations of the Code of Conduct:
Moderator: This is a friendly reminder for everyone to follow the Code of Conduct: https://code-of-conduct.freecodecamp.org/
-
-
Don’t brag about being a moderator
Do not see yourself as above the community. You are the community. And the community has trusted you to help protect something rare that we all share - a welcoming place for new developers.
If you brag about being a moderator, people may feel uneasy around you, in the same way that people may feel uneasy around a police officer, even if they’re doing nothing wrong. This is just human nature.
-
Don’t contradict other moderators
If you disagree with a moderator's action, talk with them in private or bring it up in the #mod-chat channel. Never override a moderator's action, and never contradict the other moderator(s) publicly. Instead, have a cool-headed discussion in
#mod-chatand convince the moderator that they themselves should reverse their ban or change their PoV (Point of View).Remember: We’re all on the same team. We want to dignify the role of moderators and present a unified front.
-
Talk with other moderators
We have a
#mod-chatroom for moderators only. Use it! If you feel uncomfortable with handling a certain situation, ask other moderators for help. If you think something should be discussed, do it. You're part of the team, and we value every team member's input! Even if you totally disagree with anything in these guidelines or the Code of Conduct! -
Temporarily inactive
If you're not going to be active as a Moderator for a while due to vacation, illness, or any other reason, make sure to let the others know in the
#mod-chatchannel. This is so we know if we can count on you to be regularly active on the server or not.
How to Become a Moderator
Suppose you are helping people in the community consistently over time. In that case, our moderator team will eventually take notice, and one of them will mention you as a possible moderator to our staff. There are no shortcuts to becoming a moderator.
If you are approved, we will add you to our moderator teams on GitHub, forum, chat, etc.
[!NOTE] For GitHub: After you've been accepted as a moderator, you will receive a Github repository invitation. You'll need to head over towards freeCodeCamp GitHub Organization Invitation to be able to accept the invitation.
This is required for us to be able to give you write access to some of our repositories.
How Our Contributors Room Works
Anyone is welcome in the contributors room on our chat server. It is the designated chat room for moderators and other campers who contribute to our community in any number of ways, including through study groups.
We assume contributors will read anything in this room that directly mentions them with an @username. Everything else is optional, but feel free to read anything anyone posts in there and interact.
Dealing with Solicitors
You may be approached by organizations who want to partner or co-brand with freeCodeCamp somehow. Once you realize that this is what they're after, please stop talking to them and tell them to email team[at]freecodecamp.org.
We get proposals like this all the time, and the staff are in the best position to judge whether such a relationship will be worth it for our community (and it rarely is).
Dealing with (Mental) Health Inquiries
You may come across situations where users seek medical advice or are dealing with mental health issues and are looking for support.
As a matter of policy, you should avoid talking privately about these matters. Should the situation reflect back to freeCodeCamp, we want to have the conversation(s) on record. Make it clear that we are not medical professionals and that you encourage the user to find professional help.
As difficult as it sometimes can be, avoid giving any tips or advice and rather point the user in the direction of seeking professional help!
If this happens on our chat server: Create a private channel for the user and the moderator team. This can be done with the bot's private command.
- The user is guaranteed some privacy.
- Public chat is no longer disrupted.
- Other team members can pitch in, should you feel uncomfortable dealing with the situation yourself.
Helpful URLs:
http://suicide.org/international-suicide-hotlines.html
A Note on Free Speech
Sometimes people will defend something offensive or incendiary that they said as "free speech."
This XKCD comic summarizes perfectly most communities' thoughts on free speech.
Thanks for reading this, and thanks for helping the developer community!

![A blue text message saying "This is the first time [person] has posted - let's welcome them to the community!](https://i.imgur.com/mPmVgzK.png)
