chore(i8n,docs): processed translations (#41252)
Co-authored-by: Crowdin Bot <support+bot@crowdin.com>
This commit is contained in:
Nicholas Carrigan (he/him)
committed by
GitHub
GitHub
parent
f62de2d0e6
commit
66e40dbd6f
@ -653,7 +653,7 @@ Provisioning VMs with the Code
|
||||
cd client
|
||||
```
|
||||
|
||||
Start placeholder instances for the web client, these will be updated with artifacts from the Azure pipline.
|
||||
Start placeholder instances for the web client, these will be updated with artifacts from the Azure pipeline.
|
||||
|
||||
> Todo: This setup needs to move to S3 or Azure Blob storage
|
||||
>
|
||||
|
||||
@ -83,15 +83,15 @@ Start [using MailHog](#using-mailhog).
|
||||
|
||||
Open a new browser tab or window and navigate to [http://localhost:8025](http://localhost:8025) to open your MailHog inbox when the MailHog installation has completed and MailHog is running. The inbox will appear similar to the screenshot below.
|
||||
|
||||
|
||||
|
||||
|
||||
Emails sent by your freeCodeCamp installation will appear as below
|
||||
|
||||
|
||||
|
||||
|
||||
Two tabs that allow you to view either plain text or source content will be available when you open a given email. Ensure that the plain text tab is selected as below.
|
||||
|
||||
|
||||
|
||||
|
||||
All links in the email should be clickable and resolve to their URL.
|
||||
|
||||
|
||||
@ -44,13 +44,13 @@ Some examples of good PRs titles would be:
|
||||
|
||||
1. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page.
|
||||
|
||||
|
||||
|
||||
|
||||
2. By default, all pull requests should be against the freeCodeCamp main repo, `main` branch.
|
||||
|
||||
Make sure that your Base Fork is set to freeCodeCamp/freeCodeCamp when raising a Pull Request.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Submit the pull request from your branch to freeCodeCamp's `main` branch.
|
||||
|
||||
@ -117,7 +117,7 @@ When you are working on regular bugs and features on our development branch `mai
|
||||
|
||||
### For upcoming curriculum and features
|
||||
|
||||
When you are working on features for our upcoming curriculum `next-*` branches, you have do a cherry pick:
|
||||
When you are working on features for our upcoming curriculum `next-*` branches, you have to do a cherry pick:
|
||||
|
||||
1. Make sure your upstream comes in sync with your local:
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
你将看到你已被授予访问权限的项目列表。 选择你想参与校对的项目，然后选择你要校对的语言版本。
|
||||
|
||||
|
||||
|
||||
|
||||
在文件列表中， 通过点击文件右侧的 `Proofread` 按钮选择你要校对的文件，然后从出现的下拉菜单中选择 `Proofreading`。
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
|
||||
## 校对译文
|
||||
|
||||
|
||||
|
||||
|
||||
<!--Add proofread/crowdsource button to the image-->
|
||||
|
||||
|
||||
@ -10,11 +10,11 @@
|
||||
|
||||
选择你想参与贡献的项目，然后你会看到不同语言版本的可翻译文件列表。
|
||||
|
||||
|
||||
|
||||
|
||||
选择你想参与翻译的语言，然后你会看到完整的文件列表。
|
||||
|
||||
|
||||
|
||||
|
||||
每个文件和文件夹都会显示一个进度条。 进度条的**蓝色**部分表示多少百分比的文件已经被翻译了，而**绿色**部分表示多少百分比的文件已经被校对团队审核确认。
|
||||
|
||||
@ -24,7 +24,7 @@
|
||||
|
||||
## 翻译文件
|
||||
|
||||
|
||||
|
||||
|
||||
Crowdin 将一个文件分割成“字符串”（通常是一个个句子），以供翻译。 请单独翻译每个字符串。 在上图中：
|
||||
|
||||
@ -67,7 +67,7 @@ Crowdin 通过这些投票为一个字符串的每个建议译文给出一个分
|
||||
|
||||
当你尝试保存翻译时，你可能会看到一条警告消息，其中包含关于你所建议的翻译的通知。
|
||||
|
||||
|
||||
|
||||
|
||||
当 Crowdin 的质量保证检查系统在建议的译文中发现可能的错误时，将显示此消息。 在这个例子中，我们修改了 `<code>` 标签的文本内容，Crowdin 会发现这个问题。
|
||||
|
||||
|
||||
@ -186,7 +186,7 @@ To change text on the client side of things, go to the relevant `.json` file, fi
|
||||
|
||||
If the text you want to add to the client exists in the relevant `.json` file, use the existing key. Otherwise, create a new key.
|
||||
|
||||
The matching filename`-schema.js` file is the "source of truth" for all of the `.json` files sharing the same name. If you need to add a new key, add it there. Then, add the key to **all** of the `translations.json` files.
|
||||
The English file is the "source of truth" for all of the `.json` files sharing the same name. If you need to add a new key, add it there. Then, add the key to **all** of the `translations.json` files.
|
||||
|
||||
> [!NOTE] Use English text for all languages if the file is translated through Crowdin. The tests will fail if you don't.
|
||||
|
||||
|
||||
@ -166,7 +166,7 @@ Forum moderators have the ability to delete user's posts. You should only do thi
|
||||
|
||||
### Dealing with spam
|
||||
|
||||
For the first spam post of a user, 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 follow the process above. Quietly block the user from posting (using the silence option on the User Admin panel), then send a warning with the Code of Conduct. Check the box in the private message indicating that your message is a "formal warning."
|
||||
For the first spam post of a user, 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."
|
||||
|
||||
You can ask questions and report incidents in the in the [staff forum section](https://forum.freecodecamp.com/c/staff).
|
||||
|
||||
@ -200,49 +200,42 @@ Sometimes people will post things that they think are funny. They don't realize
|
||||
|
||||
But if it is an egregious offense that can't reasonably be attributed to a cultural difference or a misunderstanding of the English language, then you should strongly consider blocking the member from the Facebook group.
|
||||
|
||||
## Moderating Discord
|
||||
## Moderating Chat
|
||||
|
||||
Here's how moderators deal with violations of our [Code of Conduct](https://code-of-conduct.freecodecamp.org/) on Discord:
|
||||
Here's how moderators deal with violations of our [Code of Conduct](https://code-of-conduct.freecodecamp.org/) on our chat server:
|
||||
|
||||
1. **Make sure it was intended to violate the Code of Conduct.** Not all violations of the CoC were intended as such. A new camper might post a large amount of code for help, unaware that this can be considered spamming. In these cases, you can just ask them to paste their code with services like Codepen or Pastebin.
|
||||
|
||||
2. **If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:**
|
||||
|
||||
- Ban the offending person from the Discord Server. In order to ban someone, right-click on their username/profile picture and select "Ban username". You will be given the option to delete their previous messages - select "Don't delete any", as the messages should remain present as a historic record.
|
||||
- Report a short summary of the event in the #mod-log channel. Here's an example of what such a summary might look like:
|
||||
2. **If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:** Kick or mute the offending person from the chat room. In order to kick or mute someone, left-click on their profile picture, select the three dots, and select "Remove from room" to kick or "Mute user" to prevent them from sending messages. Then report a short summary of the event in the #mod-log channel. Here's an example of what such a summary might look like:
|
||||
|
||||
```
|
||||
Banned: _@username_
|
||||
Kicked: _@username_
|
||||
Reason(s): _Spamming, trolling_
|
||||
Evidence: _One or more links to the offending message(s)_
|
||||
```
|
||||
|
||||
- If you decide to ban someone, it means they're unwilling to abide to our Code of Conduct. Therefore unbanning a Camper should rarely occur. However, if the need arises, you can do so by clicking on the server name, choosing "Server Settings", choosing "Bans", selecting the user you wish to unban, and clicking "Revoke Ban".
|
||||
3. **Creating a Private Discussion** There may be situations where you need to address a concern with a camper privately. This should not be done through DMs, as this can lead to situations where you claim one thing and the camper claims another. Instead, use the bot's functionality to create a private discussion:
|
||||
|
||||
Discord Bans are global - you cannot ban a user from a specific channel, only from the entire server.
|
||||
- Call the `!fCC private username` command, where `username` is the camper's chat user name.
|
||||
- The bot will create a new channel, and add the mentioned camper and all moderators with the `Your Friendly Moderator` role. 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, call the `!fCC close` command _in the private channel_ to have the bot close and delete that channel.
|
||||
|
||||
3. **Creating a Private Discussion**
|
||||
|
||||
There may be situations where you need to address a concern with a camper privately. This should not be done through DMs, as this can lead to situations where you claim one thing and the camper claims another. Instead, use the bot's functionality to create a private discussion:
|
||||
|
||||
- Call the `!fCC moderate private @username` command, where `@username` is the _Discord mention_ of the user. If you are calling this command from a private channel (such as #mod-chat), you will need to parse the mention manually: Ensure you have Developer Mode turned on in your Discord settings, then right-click on the user's avatar and select `Copy ID`. Replace the `@username` parameter with `<@!ID>`, where `ID` is the value you copied earlier. The result should look like: `!fCC moderate private <@!465650873650118659>`.
|
||||
- The bot will create a new channel under the `private` category and add the `@username`-mentioned camper and all moderators with the `Your Friendly Moderator` role. 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, call the `!fCC moderate close` command _in the private channel_ to have the bot close and delete that channel.
|
||||
|
||||
4. **Deleting messages** Moderators have the ability to delete messages on Discord. They should only exercise this ability in four very specific situations:
|
||||
4. **Deleting messages** Moderators can delete messages on our chat server. They should only exercise this ability in four very specific situations:
|
||||
|
||||
- Someone has posted a pornographic or graphically violent image.
|
||||
- Someone has posted a link or code that is malicious in nature and could harm other campers who click on it.
|
||||
- Someone has flooded the chat with lots of spam messages to such an extreme extent (usually involving bots) as to render chat completely unusable.
|
||||
- Someone has posted an advertisement and/or a self-promoting message/image (social media).
|
||||
|
||||
In all other situations - even situations where the code of conduct is violated - Moderators should not delete the message as these are an important historic record. When you do delete a message, make sure you take a screenshot of it first! The screenshot can be logged in the #mod-log channel, but for the #activity-log it is sufficient to say the evidence was "removed due to sensitive content". Note: If the message contains material that would be illegal to take a screenshot of, copy the message link instead - provide that message link to @raisedadead to forward to Discord's Trust and Safety team.
|
||||
In all other situations - even situations where the code of conduct is violated - moderators should not delete the messages as they are important historic records. When you do delete a message, make sure you take a screenshot of it first! The screenshot can be logged in the #mod-log channel.
|
||||
|
||||
5. **Don’t use @everyone or @here** Don’t use @everyone or @here under any circumstances! Every single person in that chat room will get a notification. In some cases, tens of thousands of people. Instead, if you want people to see an announcement, you can pin it to the channel to allow everyone to read it.
|
||||
> [!NOTE] If the message contains material that would be illegal to take a screenshot of, copy the message link instead - provide that message link to @raisedadead to forward to Discord's Trust and Safety team.
|
||||
|
||||
6. **Don’t threaten to ban** If a camper is breaking the code of conduct, don’t threaten to ban them, and never warn them in public. Instead, talk to them privately using the bot's `private` command. No one else in that channel needs to know that you banned/suspended the person - campers can view the summary in the #activity-log channel if they want to keep up on that information. If a violation was clearly unintended and doesn't warrant a suspension or private conversation, make the offending camper aware of his / her actions without making it come across as a warning. For example:
|
||||
5. **Don’t use @all or @here** Don’t use @all or @here under any circumstances! Every single person in that chat room will get a notification. In some cases, tens of thousands of people. Instead, if you want people to see an announcement, you can pin it to the channel to allow everyone to read it.
|
||||
|
||||
- Camper posts a wall of code to request help
|
||||
6. **Don’t threaten to take action** If a camper is breaking 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 `private` command. No one else in that channel needs to know that you banned/suspended the person. If a violation was clearly unintended and doesn't warrant a suspension or private conversation, make the offending camper aware of his / her 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.
|
||||
|
||||
@ -250,26 +243,18 @@ In all other situations - even situations where the code of conduct is violated
|
||||
|
||||
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
|
||||
- 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/
|
||||
|
||||
7. **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.
|
||||
7. **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.
|
||||
|
||||
8. **Don’t contradict other moderators** If you disagree with the action of a moderator, talk with them in private or bring it up in the #mod-chat channel. Never override a ban, and never contradict the other moderator(s) publicly. Instead, have a cool-headed discussion in mod-chat and convince the moderator that they themselves should reverse their ban or change their point of view. Remember: we’re all on the same team. We want to dignify the role of moderators and present a unified front.
|
||||
8. **Don’t contradict other moderators** If you disagree with the action of a moderator, 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-chat and convince the moderator that they themselves should reverse their ban or change their point of view. Remember: we’re all on the same team. We want to dignify the role of moderators and present a unified front.
|
||||
|
||||
9. **Talk with other moderators** We have a room for moderators only. Use it! If you feel uncomfortable with how to handle 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 the input of every team member! Even if you totally disagree with anything in these guidelines or the Code of Conduct!
|
||||
|
||||
10. **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-chat channel. This is so we know if we can count on you to be regularly active on the server or not.
|
||||
|
||||
## Moderating our Chat Server
|
||||
|
||||
Moderating the chat server is very similar to moderating the Discord server, but there are a few key differences:
|
||||
|
||||
1. **No Ban functionality** At this time, Rocket.Chat does not have a flow for banning users. Users can be muted (so they are prevented from chatting in a room) or kicked from a room.
|
||||
2. **Modified Bot Commands** The moderation bot in the chat server was developed with a smoother UX in mind. Some of the commands have been modified. Use the `!fCC modHelp` command to view the available functionality. Bot commands in the chat server do NOT require a user mention as they do with Discord.
|
||||
3. **No Role Mentions** Unlike Discord, Rocket.Chat does not allow you to mention all users by a specific role - this means you cannot ping all moderators at once.
|
||||
|
||||
## How to become a moderator
|
||||
|
||||
If you are helping people in the community consistently over time, our Moderator Team will eventually take notice, and one of them will mention you as a possible moderator to [our staff](https://forum.freecodecamp.org/g/Team). There are no shortcuts to becoming a moderator.
|
||||
@ -300,16 +285,12 @@ You may be approached by organizations who want to partner or co-brand with free
|
||||
|
||||
You may come across situations where users are seeking 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 at some point reflect back to fCC, 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 other than pointing the user in the direction of professional help!
|
||||
|
||||
If this happens on Discord: Create a private channel for the user and the mod team. This can be done with the bot's `private` command.
|
||||
If this happens on our chat server: Create a private channel for the user and the mod 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 be uncomfortable dealing with the situation yourself
|
||||
|
||||
If you believe the user is capable of rejoining the community, right-click on the private channel and copy the ID. Put the following message in #mod-log:
|
||||
|
||||
> Reference medical advice: `<channel ID> <username>`
|
||||
|
||||
Helpful URLs:
|
||||
|
||||
http://www.suicide.org/international-suicide-hotlines.html
|
||||
|
||||
@ -653,7 +653,7 @@ Aprovisionamiento de las VMs con el código
|
||||
cd client
|
||||
```
|
||||
|
||||
Inicia las instancias de marcador para el cliente web, estas se actualizarán con artefactos del flujo de Azure.
|
||||
Start placeholder instances for the web client, these will be updated with artifacts from the Azure pipeline.
|
||||
|
||||
> Todo: This setup needs to move to S3 or Azure Blob storage
|
||||
>
|
||||
|
||||
@ -83,15 +83,15 @@ Empieza [a usar MailHog](#using-mailhog).
|
||||
|
||||
Abra una nueva pestaña o ventana del navegador y vaya a [http://localhost:8025](http://localhost:8025) para abrir su bandeja de entrada de MailHog cuando se haya completado la instalación y éste se encuentre funcionando. The inbox will appear similar to the screenshot below.
|
||||
|
||||
|
||||
|
||||
|
||||
Los correos enviados por tu instalación de freeCodeCamp aparecerán como se presenta a continuación
|
||||
|
||||
|
||||
|
||||
|
||||
Dos pestañas que le permiten ver texto plano o contenido fuente estarán disponibles cuando abra un determinado correo electrónico. Asegúrese de que la pestaña de texto plano está seleccionada como abajo.
|
||||
|
||||
|
||||
|
||||
|
||||
Todos los enlaces en el correo electrónico deben poder ser pulsados y resueltos a su URL.
|
||||
|
||||
|
||||
@ -2,28 +2,28 @@
|
||||
|
||||
Una pull request (PR) le permite enviar cambios desde su bifurcación en GitHub al repositorio principal de freeCodeCamp.org. Una vez que haya hecho cambios en el código, puede seguir estas pautas para abrir un PR.
|
||||
|
||||
> [!NOTE] Your PR should be in English. See [here](#index.md?id=translations) for how to contribute translations.
|
||||
> [!NOTE] Tu PR debe ser en inglés. Consulta [aquí](#index.md?id=translations) para saber cómo contribuir con las traducciones.
|
||||
|
||||
## Prepara un buen título para tu PR
|
||||
|
||||
Recomendamos usar [titulos y mensajes convencionales](https://www.conventionalcommits.org/) para tus commits y pull request. La convención tiene el siguiente formato:
|
||||
|
||||
> `<type>([optional scope(s)]): <description>`
|
||||
> `<tipo>([ámbito opcional]): <descripción>`
|
||||
>
|
||||
> For example:
|
||||
> Por ejemplo:
|
||||
>
|
||||
> `fix(learn): tests for the do...while loop challenge`
|
||||
|
||||
When opening a Pull Request(PR), you can use the below to determine the type, scope (optional), and description.
|
||||
Al abrir una Pull Request(PR), puedes utilizar la siguiente guía para determinar el tipo, ámbito (opcional) y descripción de la PR.
|
||||
|
||||
**Tipo:**
|
||||
|
||||
| Tipo | Cuándo seleccionar |
|
||||
|:----- |:-------------------------------------------------------------------------------- |
|
||||
| fix | Changed or updated/improved functionality, tests, the verbiage of a lesson, etc. |
|
||||
| feat | Sólo si está añadiendo nuevas funcionalidades, pruebas, etc. |
|
||||
| chore | Changes that are not related to code, tests, or verbiage of a lesson. |
|
||||
| docs | Cambios al directorio `/docs` o a las pautas de contribución, etc. |
|
||||
| Tipo | Cuándo seleccionar |
|
||||
|:----- |:------------------------------------------------------------------------------------------ |
|
||||
| fix | Funcionalidades actualizadas o mejoradas, pruebas, redacción de la lección, etc. |
|
||||
| feat | Sólo si está añadiendo nuevas funcionalidades, pruebas, etc. |
|
||||
| chore | Cambios que no están relacionados con el código, las pruebas o la redacción de la lección. |
|
||||
| docs | Cambios al directorio `/docs` o a las pautas de contribución, etc. |
|
||||
|
||||
**Ámbito:**
|
||||
|
||||
@ -36,7 +36,7 @@ Mantenlo corto (menos de 30 caracteres) y sencillo, puedes agregar más informac
|
||||
Algunos ejemplos de buenos títulos para PRs serían:
|
||||
|
||||
- `fix(a11y): contraste mejorado en la barra de búsqueda`
|
||||
- `feat: add more tests to HTML and CSS challenges`
|
||||
- `feat: se agregan más test a los retos de HTML y CSS`
|
||||
- `fix(api,client): evitar errores CORS en el envío de formularios`
|
||||
- `docs(i18n): Traducción al chino de la configuración local`
|
||||
|
||||
@ -44,15 +44,15 @@ Algunos ejemplos de buenos títulos para PRs serían:
|
||||
|
||||
1. Una vez que las ediciones hayan sido confirmadas, se le pedirá que cree un pull request en la página de GitHub de su fork.
|
||||
|
||||
|
||||
|
||||
|
||||
2. By default, all pull requests should be against the freeCodeCamp main repo, `main` branch.
|
||||
2. De manera predeterminada, todas las pull requests deben estar en contra de la rama freeCodeCamp main repo, `main`.
|
||||
|
||||
Asegúrese de que su bifurcación base está configurada en freeCodeCamp/freeCodeCamp al elevar una solicitud de Pull Request.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Submit the pull request from your branch to freeCodeCamp's `main` branch.
|
||||
3. Envía el pull request de tu rama a la rama `main` de freeCodeCamp.
|
||||
|
||||
4. En el cuerpo de sus relaciones públicas incluya un resumen más detallado de los cambios realizados y por qué.
|
||||
|
||||
@ -64,21 +64,21 @@ Algunos ejemplos de buenos títulos para PRs serían:
|
||||
|
||||
> Ejemplo: `Cerrar #123` cerrará el problema 123
|
||||
|
||||
5. Indicate if you have tested on a local copy of the site or not.
|
||||
5. Indica si has probado en una copia local del sitio o no.
|
||||
|
||||
- This is very important when making changes that are not just edits to text content like documentation or a challenge description. Examples of changes that need local testing include JavaScript, CSS, or HTML which could change the functionality or layout of a page.
|
||||
- Esto es muy importante cuando se hagan cambios que no sean solo ediciones del contenido de texto como documentación o una descripción de un desafío. Ejemplos de los cambios que necesitan pruebas en el entorno local incluyen JavaScript, CSS o HTML que podrían cambiar la funcionalidad o el diseño de una página.
|
||||
|
||||
- If your PR affects the behaviour of a page it should be accompanied by corresponding [Cypress integration tests](/how-to-add-cypress-tests).
|
||||
- Si tu PR afecta el comportamiento de una página, debe ir acompañada de la correspondiente [pruebas de integración de Cypress](/how-to-add-cypress-tests).
|
||||
|
||||
## Comentarios sobre pull requests
|
||||
|
||||
> Congratulations! :tada: on making a PR and thanks a lot for taking the time to contribute.
|
||||
> ¡Felicidades! :tada: por hacer una PR y muchas gracias por tomarte el tiempo en contribuir.
|
||||
|
||||
Nuestros moderadores ahora echarán un vistazo y te dejarán tus comentarios. Por favor, sea paciente con los demás moderadores y respete su tiempo. Todos los pull requests son revisados a su debido tiempo.
|
||||
|
||||
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [the contributors chat room](https://chat.freecodecamp.org/channel/contributors).
|
||||
Y como siempre, siéntete libre de preguntar en la [categoría de 'Contribuidores' de nuestro foro](https://forum.freecodecamp.org/c/contributors) o [en la sala de chat de contribuidores](https://chat.freecodecamp.org/channel/contributors).
|
||||
|
||||
> [!TIP] If you are to be contributing more pull requests, we recommend you read the [making changes and syncing](https://contribute.freecodecamp.org/#/how-to-setup-freecodecamp-locally?id=making-changes-locally) guidelines to avoid having to delete your fork.
|
||||
> [!TIP] Si quieres contribuir con más PRs, te recomendamos que leas las directrices ["haciendo cambios y sincronizando"](https://contribute.freecodecamp.org/#/how-to-setup-freecodecamp-locally?id=making-changes-locally) para evitar la necesidad de borrar tu bifurcación.
|
||||
|
||||
## Conflicto en un pull request
|
||||
|
||||
@ -88,7 +88,7 @@ La mayoría de las veces no puede requerir una rebase, porque aplastamos todos l
|
||||
|
||||
### Para arreglos de errores y características habituales
|
||||
|
||||
When you are working on regular bugs and features on our development branch `main`, you are able to do a simple rebase:
|
||||
Cuando trabajas con errores regulares y funcionalidades en nuestra rama de desarrollo `main`, puedes hacer un simple rebase:
|
||||
|
||||
1. Reiniciar su copia local:
|
||||
|
||||
@ -104,7 +104,7 @@ When you are working on regular bugs and features on our development branch `mai
|
||||
git add .
|
||||
git commit -m "chore: resolve conflicts"
|
||||
|
||||
# o
|
||||
# Or
|
||||
git add .
|
||||
git commit --amend --no-edit
|
||||
```
|
||||
@ -117,7 +117,7 @@ When you are working on regular bugs and features on our development branch `mai
|
||||
|
||||
### Para los próximos planes de estudios y características
|
||||
|
||||
Cuando estás trabajando en funciones para nuestro próximo currículo `siguiente *` ramas, tienes que hacer una selección de cerezos:
|
||||
Cuando estás trabajando en características para nuestras próximas ramas del plan de estudio `next-*`, tienes que hacer un "cherry pick":
|
||||
|
||||
1. Asegúrese de que su autor está sincronizado con su local:
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ Para comenzar a revisar y aprobar traducciones, visita [ nuestro sitio de traduc
|
||||
|
||||
Deberías ver una lista de los proyectos para los que te concedieron acceso. Selecciona el proyecto que quieres revisar y luego selecciona el idioma.
|
||||
|
||||
|
||||
|
||||
|
||||
Ahora podrás ver la lista de archivos disponibles. Selecciona un archivo haciendo clic en el botón `Proofread` que se encuentra a la derecha de ese archivo, y luego selecciona la opción `Proofreading` del menú desplegable que se abrirá.
|
||||
|
||||
@ -16,7 +16,7 @@ Ahora podrás ver la lista de archivos disponibles. Selecciona un archivo hacien
|
||||
|
||||
## Revisar traducciones
|
||||
|
||||
|
||||
|
||||
|
||||
<!--Add proofread/crowdsource button to the image-->
|
||||
|
||||
|
||||
@ -135,10 +135,10 @@ Necesita una referencia de su clon local al repositorio `upstream` además del r
|
||||
The output should look something like below (replacing `YOUR_USER_NAME` with your GitHub username):
|
||||
|
||||
```console
|
||||
origin https://github.com/YOUR_USER_NAME/freeCodeCamp.git (fetch)
|
||||
origin https://github.com/YOUR_USER_NAME/freeCodeCamp.git (push)
|
||||
upstream https://github.com/freeCodeCamp/freeCodeCamp.git (fetch)
|
||||
upstream https://github.com/freeCodeCamp/freeCodeCamp.git (push)
|
||||
origin https://github.com/YOUR_USER_NAME/freeCodeCamp.git (fetch)
|
||||
origin https://github.com/YOUR_USER_NAME/freeCodeCamp.git (push)
|
||||
upstream https://github.com/freeCodeCamp/freeCodeCamp.git (fetch)
|
||||
upstream https://github.com/freeCodeCamp/freeCodeCamp.git (push)
|
||||
```
|
||||
|
||||
## Ejecutando freeCodeCamp localmente
|
||||
@ -205,7 +205,7 @@ Iniciar el servidor MongoDB en un terminal separado:
|
||||
- En Windows, debe especificar la ruta completa al binario `mondios`
|
||||
|
||||
```console
|
||||
"C:\Archivos de programa\MongoDB\Servidor\3.6\bin\mongod"
|
||||
"C:\Program Files\MongoDB\Server\3.6\bin\mongod"
|
||||
```
|
||||
|
||||
Asegúrate de reemplazar `3.6` con la versión instalada
|
||||
@ -223,7 +223,7 @@ npm run seed
|
||||
Ahora puede iniciar el servidor API y las aplicaciones cliente.
|
||||
|
||||
```console
|
||||
desarrollo de ejecución npm
|
||||
npm run develop
|
||||
```
|
||||
|
||||
Este único comando lanzará todos los servicios, incluyendo el servidor API y las aplicaciones cliente disponibles para que usted trabaje.
|
||||
@ -289,7 +289,7 @@ Siga estos pasos:
|
||||
Actualiza tu copia local del repositorio de freeCodeCamp upstream:
|
||||
|
||||
```console
|
||||
git obtener arriba
|
||||
git fetch upstream
|
||||
```
|
||||
|
||||
Hard reset your main branch with the freeCodeCamp main:
|
||||
@ -327,7 +327,7 @@ Siga estos pasos:
|
||||
Algunos ejemplos de buenos nombres de ramas son:
|
||||
|
||||
```md
|
||||
fix/update-challenges-for-reaccionar
|
||||
fix/update-challenges-for-react
|
||||
fix/update-guide-for-html-css
|
||||
fix/platform-bug-sign-in-issues
|
||||
feat/add-guide-article-for-javascript
|
||||
@ -489,7 +489,7 @@ Si usted se enfrenta a problemas con la interfaz de usuario, fuentes o ver error
|
||||
npm run clean
|
||||
npm ci
|
||||
npm run seed
|
||||
npm run developer
|
||||
npm run develop
|
||||
```
|
||||
|
||||
O
|
||||
@ -526,7 +526,7 @@ Si no puedes iniciar sesión, y en su lugar ves un banner con un mensaje de erro
|
||||
```console
|
||||
netstat -ab | grep "3000"
|
||||
|
||||
tcp4 0 0.0.0.0:3000 DESKTOP LISTEN
|
||||
tcp4 0 0 0.0.0.0:3000 DESKTOP LISTEN
|
||||
```
|
||||
|
||||
**En Windows - Desde PowerShell despegado:**
|
||||
@ -534,7 +534,7 @@ tcp4 0 0.0.0.0:3000 DESKTOP LISTEN
|
||||
```powershell
|
||||
netstat -ab | Select-String "3000"
|
||||
|
||||
TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
TCP 0.0.0.0:3000 DESKTOP LISTENING
|
||||
```
|
||||
|
||||
### Problemas instalando dependencias
|
||||
|
||||
@ -10,21 +10,21 @@ Deberías ver dos "proyectos" disponibles para traducir: el proyecto `Contributi
|
||||
|
||||
Selecciona el proyecto en el que deseas contribuir y verás una lista de idiomas disponibles para traducir.
|
||||
|
||||
|
||||
|
||||
|
||||
Selecciona el idioma en el que deseas trabajar y verás el árbol de archivos completo.
|
||||
|
||||
|
||||
|
||||
|
||||
Cada archivo y carpeta mostrará una barra de progreso. La parte **azul** de la barra de progreso indica qué porcentaje del archivo se ha traducido, mientras que la parte **verde** de la barra de progreso indica qué porcentaje del archivo ha sido aprobado por el equipo de revisión.
|
||||
|
||||
Selecciona un archivo para trabajar y Crowdin abrirá la vista de edición.
|
||||
|
||||
> [!NOTE] When the editor view opens, you will need to click the settings icon (shown as a gear) and switch the 'HTML tags displaying' setting to 'SHOW'. This will ensure you can see tags such as `<code></code>` instead of `<0></0>`.
|
||||
> [!NOTE] Cuando se abra la vista de edición, deberás hacer clic en el icono de configuración (que se muestra como un engranaje) y cambiar la configuración de ''HTML tags displaying (Mostrar etiquetas HTML)" a "SHOW (Mostrar)". Esto asegurará que puedas ver las etiquetas como `<code></code>` en lugar de `<0></0>`.
|
||||
|
||||
## Traducir un archivo
|
||||
|
||||
|
||||
|
||||
|
||||
Crowdin separa un documento en "cadenas" traducibles, normalmente oraciones. Cada cadena se traduce individualmente. Tomando como referencia la imagen anterior:
|
||||
|
||||
@ -39,19 +39,19 @@ Crowdin separa un documento en "cadenas" traducibles, normalmente oraciones. Cad
|
||||
9. Aquí puedes ver la ventana de comentarios. Si tienes preguntas o inquietudes sobre una cadena en particular, puedes dejar aquí un comentario sobre la cadena para que lo vean otros traductores.
|
||||
10. Estos dos botones de "panel" ocultarán las vistas izquierda (documento) y derecha (comentarios).
|
||||
|
||||
> [!NOTE] If you see a hidden string that includes translations, please notify us in the [translators chat room](https://chat.freecodecamp.org/channel/translators) so we can remove the translation from memory.
|
||||
> [!NOTE] Si ves una cadena oculta que incluye traducciones, notifícanos en la [ sala de chat de traductores ](https://chat.freecodecamp.org/channel/translators) para que podamos eliminar la traducción de la memoria.
|
||||
|
||||
Cuando hayas completado la traducción de una cadena, pulsa el botón `Save` (guardar) para almacenar tu traducción en Crowdin. Luego, otros contribuyentes podrán votar tu traducción y los proofreaders podrán aprobarla.
|
||||
|
||||
Eres bienvenido a traducir tantas cadenas como desees, no se requieren pasos adicionales cuando completas todo un archivo o propones una nueva traducción. Hacer clic en el botón `Save` es todo lo que se necesita para almacenar una traducción.
|
||||
|
||||
> [!NOTE] If you see something in the English source file that is inaccurate or incorrect, please do not fix it through the translation flow. Instead, leave a comment on the string to notify us that there is a discrepancy, or create a GitHub issue.
|
||||
> [!NOTE] Si ves algo en el archivo fuente en inglés que sea inexacto o incorrecto, no lo corrijas a través del flujo de traducción. En su lugar, deja un comentario en la cadena para notificarnos que hay una discrepancia, o crea un issue en GitHub.
|
||||
|
||||
### Traducir la documentación
|
||||
|
||||
Traducir nuestra documentación de contribución es un proceso similar a traducir nuestros archivos de currículo.
|
||||
|
||||
> [!NOTE] Our contributing documentation is powered by `docsify`, and we have special parsing for message boxes like this one. If you see strings that start with `[!NOTE]`, `[!WARNING]`, or `[!TIP]`, these words should NOT be translated.
|
||||
> [!NOTE] Nuestra documentación de contribución esta basada en `docsify`, y tenemos una forma especial de procesar los cuadros de mensaje como este. Si ves cadenas que comiencen con `[!NOTE]`, `[!WARNING]` o ` [!TIP]`, estas palabras NO deben traducirse.
|
||||
|
||||
## Calificar traducciones
|
||||
|
||||
@ -67,18 +67,18 @@ Hemos habilitado algunos pasos de control de calidad que verificarán que una tr
|
||||
|
||||
Cuando intentes guardar una traducción, es posible que veas aparecer un mensaje de advertencia con una notificación sobre tu traducción propuesta.
|
||||
|
||||
|
||||
|
||||
|
||||
Este mensaje aparece cuando el sistema de control de calidad de Crowdin ha identificado un posible error en la traducción propuesta. En este ejemplo, hemos modificado el texto de una etiqueta `<code>` y Crowdin lo ha detectado.
|
||||
|
||||
> [!WARNING] You have the option to save a translation in spite of errors. If you do, by clicking "Save Anyway", you should also tag a proofreader or project manager and explain why the QA message needs to be ignored in this case.
|
||||
> [!WARNING] Tienes la opción de guardar una traducción a pesar de los errores. Si lo haces, al hacer clic en "Save Anyway (Guardar de todos modos)", también debes etiquetar a un miembro del equipo de revisión o encargado del proyecto y explicar por qué el mensaje de control de calidad debe ignorarse en este caso.
|
||||
|
||||
## Buenas prácticas de traducción
|
||||
|
||||
Follow these guidelines to ensure our translations are as accurate as possible:
|
||||
Sigue estas pautas para asegurarte de que nuestras traducciones sean lo más precisas posible:
|
||||
|
||||
- No traduzcas el contenido dentro de las etiquetas `<code>`. Estas etiquetas indican texto que se encuentra en el código y deben dejarse en inglés.
|
||||
- No agregues contenido adicional. Si crees que un desafío requiere cambios en el contenido del texto o información adicional, debes proponer los cambios a través de un issue de GitHub o una pull request que modifique el archivo en inglés.
|
||||
- No cambies el orden del contenido.
|
||||
|
||||
If you have any questions, feel free to reach out to us in our [translators chat room](https://chat.freecodecamp.org/channel/translators) and we will be happy to assist you.
|
||||
Si tienes alguna pregunta, no dudes en comunicarte con nosotros en nuestra [sala de chat de traductores](https://chat.freecodecamp.org/channel/translators) y estaremos encantados de ayudarte.
|
||||
|
||||
@ -186,7 +186,7 @@ To change text on the client side of things, go to the relevant `.json` file, fi
|
||||
|
||||
If the text you want to add to the client exists in the relevant `.json` file, use the existing key. Otherwise, create a new key.
|
||||
|
||||
The matching filename`-schema.js` file is the "source of truth" for all of the `.json` files sharing the same name. If you need to add a new key, add it there. Then, add the key to **all** of the `translations.json` files.
|
||||
The English file is the "source of truth" for all of the `.json` files sharing the same name. If you need to add a new key, add it there. Then, add the key to **all** of the `translations.json` files.
|
||||
|
||||
> [!NOTE] Use English text for all languages if the file is translated through Crowdin. The tests will fail if you don't.
|
||||
|
||||
|
||||
@ -166,7 +166,7 @@ Los moderadores del foro tienen la capacidad de borrar los mensajes del usuario.
|
||||
|
||||
### Tratando con spam
|
||||
|
||||
Para el primer mensaje de correo no deseado de un usuario, envíe un mensaje explicando el problema, y elimine el enlace o mensaje según corresponda. Deja una nota en el perfil del usuario explicando la acción que has tomado. Si el problema persiste, siga el proceso anterior. Bloquear silenciosamente al usuario de publicar (usando la opción de silencio en el panel de Administración de Usuarios), luego enviar una advertencia con el Código de Conducta. Marque la casilla del mensaje privado indicando que su mensaje es una "advertencia formal".
|
||||
Para el primer mensaje de correo no deseado de un usuario, envíe un mensaje explicando el problema, y elimine el enlace o mensaje según corresponda. Deja una nota en el perfil del usuario explicando la acción que has tomado. 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. Marque la casilla del mensaje privado indicando que su mensaje es una "advertencia formal".
|
||||
|
||||
Puedes hacer preguntas e informar de incidentes en la sección [del foro del personal](https://forum.freecodecamp.com/c/staff).
|
||||
|
||||
@ -200,49 +200,42 @@ A veces la gente publicará cosas que creen que son divertidas. No se dan cuenta
|
||||
|
||||
Pero si se trata de una ofensa atroz que no puede atribuirse razonablemente a una diferencia cultural o a un malentendido del idioma inglés. entonces debe considerar fuertemente bloquear al miembro del grupo de Facebook.
|
||||
|
||||
## Moderando Discord
|
||||
## Moderating Chat
|
||||
|
||||
Así es como los moderadores tratan las violaciones de nuestro [Código de Conducta](https://code-of-conduct.freecodecamp.org/) en Discord:
|
||||
Here's how moderators deal with violations of our [Code of Conduct](https://code-of-conduct.freecodecamp.org/) on our chat server:
|
||||
|
||||
1. **Make sure it was intended to violate the Code of Conduct.** Not all violations of the CoC were intended as such. A new camper might post a large amount of code for help, unaware that this can be considered spamming. In these cases, you can just ask them to paste their code with services like Codepen or Pastebin.
|
||||
|
||||
2. **If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:**
|
||||
|
||||
- Ban the offending person from the Discord Server. In order to ban someone, right-click on their username/profile picture and select "Ban username". You will be given the option to delete their previous messages - select "Don't delete any", as the messages should remain present as a historic record.
|
||||
- Report a short summary of the event in the #mod-log channel. Here's an example of what such a summary might look like:
|
||||
2. **If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:** Kick or mute the offending person from the chat room. In order to kick or mute someone, left-click on their profile picture, select the three dots, and select "Remove from room" to kick or "Mute user" to prevent them from sending messages. Then report a short summary of the event in the #mod-log channel. Here's an example of what such a summary might look like:
|
||||
|
||||
```
|
||||
Banned: _@username_
|
||||
Kicked: _@username_
|
||||
Reason(s): _Spamming, trolling_
|
||||
Evidence: _One or more links to the offending message(s)_
|
||||
```
|
||||
|
||||
- If you decide to ban someone, it means they're unwilling to abide to our Code of Conduct. Therefore unbanning a Camper should rarely occur. However, if the need arises, you can do so by clicking on the server name, choosing "Server Settings", choosing "Bans", selecting the user you wish to unban, and clicking "Revoke Ban".
|
||||
3. **Creating a Private Discussion** There may be situations where you need to address a concern with a camper privately. This should not be done through DMs, as this can lead to situations where you claim one thing and the camper claims another. Instead, use the bot's functionality to create a private discussion:
|
||||
|
||||
Los Bans de Discord son globales - no puedes banear a un usuario de un canal específico, solo de todo el servidor.
|
||||
- Call the `!fCC private username` command, where `username` is the camper's chat user name.
|
||||
- The bot will create a new channel, and add the mentioned camper and all moderators with the `Your Friendly Moderator` role. 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, call the `!fCC close` command _in the private channel_ to have the bot close and delete that channel.
|
||||
|
||||
3. **Creating a Private Discussion**
|
||||
|
||||
There may be situations where you need to address a concern with a camper privately. This should not be done through DMs, as this can lead to situations where you claim one thing and the camper claims another. Instead, use the bot's functionality to create a private discussion:
|
||||
|
||||
- Call the `!fCC moderate private @username` command, where `@username` is the _Discord mention_ of the user. If you are calling this command from a private channel (such as #mod-chat), you will need to parse the mention manually: Ensure you have Developer Mode turned on in your Discord settings, then right-click on the user's avatar and select `Copy ID`. Replace the `@username` parameter with `<@!ID>`, where `ID` is the value you copied earlier. The result should look like: `!fCC moderate private <@!465650873650118659>`.
|
||||
- The bot will create a new channel under the `private` category and add the `@username`-mentioned camper and all moderators with the `Your Friendly Moderator` role. 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, call the `!fCC moderate close` command _in the private channel_ to have the bot close and delete that channel.
|
||||
|
||||
4. **Deleting messages** Moderators have the ability to delete messages on Discord. They should only exercise this ability in four very specific situations:
|
||||
4. **Deleting messages** Moderators can delete messages on our chat server. They should only exercise this ability in four very specific situations:
|
||||
|
||||
- Someone has posted a pornographic or graphically violent image.
|
||||
- Someone has posted a link or code that is malicious in nature and could harm other campers who click on it.
|
||||
- Someone has flooded the chat with lots of spam messages to such an extreme extent (usually involving bots) as to render chat completely unusable.
|
||||
- Someone has posted an advertisement and/or a self-promoting message/image (social media).
|
||||
|
||||
In all other situations - even situations where the code of conduct is violated - Moderators should not delete the message as these are an important historic record. When you do delete a message, make sure you take a screenshot of it first! The screenshot can be logged in the #mod-log channel, but for the #activity-log it is sufficient to say the evidence was "removed due to sensitive content". Note: If the message contains material that would be illegal to take a screenshot of, copy the message link instead - provide that message link to @raisedadead to forward to Discord's Trust and Safety team.
|
||||
In all other situations - even situations where the code of conduct is violated - moderators should not delete the messages as they are important historic records. When you do delete a message, make sure you take a screenshot of it first! The screenshot can be logged in the #mod-log channel.
|
||||
|
||||
5. **Don’t use @everyone or @here** Don’t use @everyone or @here under any circumstances! Every single person in that chat room will get a notification. In some cases, tens of thousands of people. Instead, if you want people to see an announcement, you can pin it to the channel to allow everyone to read it.
|
||||
> [!NOTE] If the message contains material that would be illegal to take a screenshot of, copy the message link instead - provide that message link to @raisedadead to forward to Discord's Trust and Safety team.
|
||||
|
||||
6. **Don’t threaten to ban** If a camper is breaking the code of conduct, don’t threaten to ban them, and never warn them in public. Instead, talk to them privately using the bot's `private` command. No one else in that channel needs to know that you banned/suspended the person - campers can view the summary in the #activity-log channel if they want to keep up on that information. If a violation was clearly unintended and doesn't warrant a suspension or private conversation, make the offending camper aware of his / her actions without making it come across as a warning. For example:
|
||||
5. **Don’t use @all or @here** Don’t use @all or @here under any circumstances! Every single person in that chat room will get a notification. In some cases, tens of thousands of people. Instead, if you want people to see an announcement, you can pin it to the channel to allow everyone to read it.
|
||||
|
||||
- Camper posts a wall of code to request help
|
||||
6. **Don’t threaten to take action** If a camper is breaking 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 `private` command. No one else in that channel needs to know that you banned/suspended the person. If a violation was clearly unintended and doesn't warrant a suspension or private conversation, make the offending camper aware of his / her 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.
|
||||
|
||||
@ -250,26 +243,18 @@ In all other situations - even situations where the code of conduct is violated
|
||||
|
||||
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
|
||||
- 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/
|
||||
|
||||
7. **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.
|
||||
7. **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.
|
||||
|
||||
8. **Don’t contradict other moderators** If you disagree with the action of a moderator, talk with them in private or bring it up in the #mod-chat channel. Never override a ban, and never contradict the other moderator(s) publicly. Instead, have a cool-headed discussion in mod-chat and convince the moderator that they themselves should reverse their ban or change their point of view. Remember: we’re all on the same team. We want to dignify the role of moderators and present a unified front.
|
||||
8. **Don’t contradict other moderators** If you disagree with the action of a moderator, 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-chat and convince the moderator that they themselves should reverse their ban or change their point of view. Remember: we’re all on the same team. We want to dignify the role of moderators and present a unified front.
|
||||
|
||||
9. **Talk with other moderators** We have a room for moderators only. Use it! If you feel uncomfortable with how to handle 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 the input of every team member! Even if you totally disagree with anything in these guidelines or the Code of Conduct!
|
||||
|
||||
10. **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-chat channel. This is so we know if we can count on you to be regularly active on the server or not.
|
||||
|
||||
## Moderating our Chat Server
|
||||
|
||||
Moderating the chat server is very similar to moderating the Discord server, but there are a few key differences:
|
||||
|
||||
1. **No Ban functionality** At this time, Rocket.Chat does not have a flow for banning users. Users can be muted (so they are prevented from chatting in a room) or kicked from a room.
|
||||
2. **Modified Bot Commands** The moderation bot in the chat server was developed with a smoother UX in mind. Some of the commands have been modified. Use the `!fCC modHelp` command to view the available functionality. Bot commands in the chat server do NOT require a user mention as they do with Discord.
|
||||
3. **No Role Mentions** Unlike Discord, Rocket.Chat does not allow you to mention all users by a specific role - this means you cannot ping all moderators at once.
|
||||
|
||||
## How to become a moderator
|
||||
|
||||
If you are helping people in the community consistently over time, our Moderator Team will eventually take notice, and one of them will mention you as a possible moderator to [our staff](https://forum.freecodecamp.org/g/Team). There are no shortcuts to becoming a moderator.
|
||||
@ -300,16 +285,12 @@ You may be approached by organizations who want to partner or co-brand with free
|
||||
|
||||
You may come across situations where users are seeking 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 at some point reflect back to fCC, 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 other than pointing the user in the direction of professional help!
|
||||
|
||||
If this happens on Discord: Create a private channel for the user and the mod team. This can be done with the bot's `private` command.
|
||||
If this happens on our chat server: Create a private channel for the user and the mod 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 be uncomfortable dealing with the situation yourself
|
||||
|
||||
If you believe the user is capable of rejoining the community, right-click on the private channel and copy the ID. Put the following message in #mod-log:
|
||||
|
||||
> Reference medical advice: `<channel ID> <username>`
|
||||
|
||||
Helpful URLs:
|
||||
|
||||
http://www.suicide.org/international-suicide-hotlines.html
|
||||
|
||||
@ -75,7 +75,7 @@ Thanks in advance for being polite and patient. Remember – this community is r
|
||||
If you have queries about the stack, architecture of the codebase, feel free to reach out to our staff dev team:
|
||||
|
||||
| Staff | Send message on Forum |
|
||||
| :-------------------- | :--------------------------------------------------------------------------- |
|
||||
|:--------------------- |:---------------------------------------------------------------------------- |
|
||||
| Mrugesh Mohapatra | [@raisedadead](https://forum.freecodecamp.org/u/raisedadead) |
|
||||
| Ahmad Abdolsaheb | [@abdolsa](https://forum.freecodecamp.org/u/abdolsa) |
|
||||
| Kristofer Koishigawa | [@scissorsneedfoodtoo](https://forum.freecodecamp.org/u/scissorsneedfoodtoo) |
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
- **Getting Started**
|
||||
- [Introduction](index.md 'Contribute to the freeCodeCamp.org Community')
|
||||
- [Introduction](index.md "Contribute to the freeCodeCamp.org Community")
|
||||
- [Frequently Asked Questions](FAQ.md)
|
||||
- **Code Contribution**
|
||||
- [Set up freeCodeCamp locally](how-to-setup-freecodecamp-locally.md)
|
||||
|
||||
@ -32,8 +32,7 @@ We employ various levels of integration and acceptance testing to check on the q
|
||||
|
||||
We have unit tests for testing our challenge solutions, Server APIs and Client User interfaces. These help us test the integration between different components.
|
||||
|
||||
> [!NOTE]
|
||||
> We are also in the process of writing end user tests which will help in replicating real world scenarios like updating an email or making a call to the API or third-party services.
|
||||
> [!NOTE] We are also in the process of writing end user tests which will help in replicating real world scenarios like updating an email or making a call to the API or third-party services.
|
||||
|
||||
Together these tests help in preventing issues from repeating themselves and ensure we do not introduce a bug while working on another bug or a feature.
|
||||
|
||||
@ -51,8 +50,7 @@ Status of builds and releases are [available here](#build-test-and-deployment-st
|
||||
|
||||
Currently, only members on the developer team can push to the production branches. The changes to the `production-*` branches can land only via fast-forward merge to the [`upstream`](https://github.com/freeCodeCamp/freeCodeCamp).
|
||||
|
||||
> [!NOTE]
|
||||
> In the upcoming days we would improve this flow to be done via pull-requests, for better access management and transparency.
|
||||
> [!NOTE] In the upcoming days we would improve this flow to be done via pull-requests, for better access management and transparency.
|
||||
|
||||
### Pushing changes to Staging Applications.
|
||||
|
||||
@ -65,10 +63,10 @@ Currently, only members on the developer team can push to the production branche
|
||||
**Results:**
|
||||
|
||||
```
|
||||
origin git@github.com:raisedadead/freeCodeCamp.git (fetch)
|
||||
origin git@github.com:raisedadead/freeCodeCamp.git (push)
|
||||
upstream git@github.com:freeCodeCamp/freeCodeCamp.git (fetch)
|
||||
upstream git@github.com:freeCodeCamp/freeCodeCamp.git (push)
|
||||
origin git@github.com:raisedadead/freeCodeCamp.git (fetch)
|
||||
origin git@github.com:raisedadead/freeCodeCamp.git (push)
|
||||
upstream git@github.com:freeCodeCamp/freeCodeCamp.git (fetch)
|
||||
upstream git@github.com:freeCodeCamp/freeCodeCamp.git (push)
|
||||
```
|
||||
|
||||
2. Make sure your `maim` branch is pristine and in sync with the upstream.
|
||||
@ -83,12 +81,9 @@ Currently, only members on the developer team can push to the production branche
|
||||
|
||||
The [continuous integration](https://github.com/freeCodeCamp/freeCodeCamp/actions) tests should be green and PASSING for the `main` branch. Click the green check mark next to the commit hash when viewing the `main` branch code.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Checking status on GitHub Actions (screenshot)
|
||||
</summary>
|
||||
<details> <summary> Checking status on GitHub Actions (screenshot) </summary>
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/devops/github-actions.png" alt="Check build status on GitHub Actions">
|
||||
|
||||
</details>
|
||||
|
||||
If this is failing you should stop and investigate the errors.
|
||||
@ -107,9 +102,8 @@ Currently, only members on the developer team can push to the production branche
|
||||
git push upstream
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> You will not be able to force push and if you have re-written the history in anyway these commands will error out.
|
||||
>
|
||||
> [!NOTE] You will not be able to force push and if you have re-written the history in anyway these commands will error out.
|
||||
>
|
||||
> If they do, you may have done something incorrectly and you should just start over.
|
||||
|
||||
The above steps will automatically trigger a run on the build pipeline for the `prod-staging` branch. Once the build is complete, the artifacts are saved as `.zip` files in a cold storage to be retrieved and used later.
|
||||
@ -121,7 +115,8 @@ The release pipeline is triggered automatically when a fresh artifact is availab
|
||||
The process is mostly the same as the staging platforms, with a few extra checks in place. This is just to make sure, we do not break anything on freeCodeCamp.org which can see hundreds of users using it at any moment.
|
||||
|
||||
| Do NOT execute these commands unless you have verified that everything is working on the staging platform. You should not bypass or skip any testing on staging before proceeding further. |
|
||||
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| |
|
||||
|
||||
|
||||
1. Make sure your `prod-staging` branch is pristine and in sync with the upstream.
|
||||
@ -140,9 +135,8 @@ The process is mostly the same as the staging platforms, with a few extra checks
|
||||
git push upstream
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> You will not be able to force push and if you have re-written the history in anyway these commands will error out.
|
||||
>
|
||||
> [!NOTE] You will not be able to force push and if you have re-written the history in anyway these commands will error out.
|
||||
>
|
||||
> If they do, you may have done something incorrectly and you should just start over.
|
||||
|
||||
The above steps will automatically trigger a run on the build pipeline for the `prod-current` branch. Once a build artifact is ready, it will trigger a run on the release pipeline.
|
||||
@ -156,7 +150,8 @@ If the changes are working nicely and have been tested on the staging platform,
|
||||
For staff use:
|
||||
|
||||
| Check your email for a direct link or [go to the release dashboard](https://dev.azure.com/freeCodeCamp-org/freeCodeCamp/_release) after the build run is complete. |
|
||||
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| |
|
||||
|
||||
|
||||
Once one of the staff members approves a release, the pipeline will push the changes live to freeCodeCamp.org's production CDN and API servers.
|
||||
@ -166,7 +161,7 @@ Once one of the staff members approves a release, the pipeline will push the cha
|
||||
Here is the current test, build and deployment status of the codebase.
|
||||
|
||||
| Branch | Unit Tests | Integration Tests | Builds & Deployments |
|
||||
| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|:-------------------------------------------------------------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:--------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [`main`](https://github.com/freeCodeCamp/freeCodeCamp/tree/main) | [](https://github.com/freeCodeCamp/freeCodeCamp/actions?query=workflow%3A%22Node.js+CI%22) | [](https://dashboard.cypress.io/projects/ke77ns/analytics/runs-over-time) | - |
|
||||
| [`prod-staging`](https://github.com/freeCodeCamp/freeCodeCamp/tree/prod-staging) | [](https://github.com/freeCodeCamp/freeCodeCamp/actions?query=workflow%3A%22Node.js+CI%22+branch%3Aprod-staging) | [](https://dashboard.cypress.io/projects/ke77ns/analytics/runs-over-time) | [Azure Pipelines](https://dev.azure.com/freeCodeCamp-org/freeCodeCamp/_dashboards/dashboard/d59f36b9-434a-482d-8dbd-d006b71713d4) |
|
||||
| [`prod-current`](https://github.com/freeCodeCamp/freeCodeCamp/tree/prod-staging) | [](https://github.com/freeCodeCamp/freeCodeCamp/actions?query=workflow%3A%22Node.js+CI%22+branch%3Aprod-current) | [](https://dashboard.cypress.io/projects/ke77ns/analytics/runs-over-time) | [Azure Pipelines](https://dev.azure.com/freeCodeCamp-org/freeCodeCamp/_dashboards/dashboard/d59f36b9-434a-482d-8dbd-d006b71713d4) |
|
||||
@ -185,7 +180,7 @@ We thank you for reporting bugs that you encounter and help in making freeCodeCa
|
||||
Currently a public beta testing version is available at:
|
||||
|
||||
| Application | Language | URL |
|
||||
| :---------- | :------- | :--------------------------------------- |
|
||||
|:----------- |:-------- |:---------------------------------------- |
|
||||
| Learn | English | <https://www.freecodecamp.dev> |
|
||||
| | Espanol | <https://www.freecodecamp.dev/espanol> |
|
||||
| | Chinese | <https://chinese.freecodecamp.dev> |
|
||||
@ -194,9 +189,8 @@ Currently a public beta testing version is available at:
|
||||
| | Chinese | <https://chinese.freecodecamp.dev/forum> |
|
||||
| API | - | `https://api.freecodecamp.dev` |
|
||||
|
||||
> [!NOTE]
|
||||
> The domain name is different than **`freeCodeCamp.org`**. This is intentional to prevent search engine indexing and avoid confusion for regular users of the platform.
|
||||
>
|
||||
> [!NOTE] The domain name is different than **`freeCodeCamp.org`**. This is intentional to prevent search engine indexing and avoid confusion for regular users of the platform.
|
||||
>
|
||||
> The above list not exhaustive of all the applications that we provision. Also not all language variants are deployed in staging to conserve resources.
|
||||
|
||||
### Identifying the current version of the platforms
|
||||
@ -236,7 +230,7 @@ You may send an email to `dev[at]freecodecamp.org` if you have any queries. As a
|
||||
# Flight Manual - Server Maintenance
|
||||
|
||||
> [!WARNING]
|
||||
>
|
||||
>
|
||||
> 1. The guide applies to the **freeCodeCamp Staff members only**.
|
||||
> 2. These instructions should not be considered exhaustive, please use caution.
|
||||
|
||||
@ -246,8 +240,7 @@ Here are some handy commands that you can use to work on the Virtual Machines (V
|
||||
|
||||
## Get a list of the VMs
|
||||
|
||||
> [!NOTE] While you may already have SSH access to the VMs, that alone will not
|
||||
> let you list VMs unless you been granted access to the cloud portals as well.
|
||||
> [!NOTE] While you may already have SSH access to the VMs, that alone will not let you list VMs unless you been granted access to the cloud portals as well.
|
||||
|
||||
### Azure
|
||||
|
||||
@ -273,8 +266,7 @@ az vm list-ip-addresses --output table
|
||||
|
||||
### Digital Ocean
|
||||
|
||||
Install Digital Ocean CLI `doctl`:
|
||||
https://github.com/digitalocean/doctl#installing-doctl
|
||||
Install Digital Ocean CLI `doctl`: https://github.com/digitalocean/doctl#installing-doctl
|
||||
|
||||
> **(One-time) Install on macOS with [`homebrew`](https://brew.sh):**
|
||||
|
||||
@ -284,8 +276,7 @@ brew install doctl
|
||||
|
||||
> **(One-time) Login:**
|
||||
|
||||
Authentication and context switching:
|
||||
https://github.com/digitalocean/doctl#authenticating-with-digitalocean
|
||||
Authentication and context switching: https://github.com/digitalocean/doctl#authenticating-with-digitalocean
|
||||
|
||||
```
|
||||
doctl auth init
|
||||
@ -301,6 +292,7 @@ doctl compute droplet list --format "ID,Name,PublicIPv4"
|
||||
|
||||
> Todo: Add instructions for spinning VM(s)
|
||||
|
||||
|
||||
<!--
|
||||
|
||||
The below instructions are stale.
|
||||
@ -397,17 +389,12 @@ az vmss create \
|
||||
|
||||
## Keep VMs updated
|
||||
|
||||
You should keep the VMs up to date by performing updates and upgrades. This will
|
||||
ensure that the virtual machine is patched with latest security fixes.
|
||||
You should keep the VMs up to date by performing updates and upgrades. This will ensure that the virtual machine is patched with latest security fixes.
|
||||
|
||||
> [!WARNING] Before you run these commands:
|
||||
>
|
||||
> - Make sure that the VM has been provisioned completely and there is no
|
||||
> post-install steps running.
|
||||
> - If you are updating packages on a VM that is already serving an application,
|
||||
> make sure the app has been stopped / saved. Package updates will cause
|
||||
> network bandwidth, memory and/or CPU usage spikes leading to outages on
|
||||
> running applications.
|
||||
>
|
||||
> - Make sure that the VM has been provisioned completely and there is no post-install steps running.
|
||||
> - If you are updating packages on a VM that is already serving an application, make sure the app has been stopped / saved. Package updates will cause network bandwidth, memory and/or CPU usage spikes leading to outages on running applications.
|
||||
|
||||
Update package information
|
||||
|
||||
@ -429,13 +416,9 @@ sudo apt autoremove -y
|
||||
|
||||
## Work on Web Servers (Proxy)
|
||||
|
||||
We are running load balanced (Azure Load Balancer) instances for our web
|
||||
servers. These servers are running NGINX which reverse proxy all of the traffic
|
||||
to freeCodeCamp.org from various applications running on their own
|
||||
infrastructures.
|
||||
We are running load balanced (Azure Load Balancer) instances for our web servers. These servers are running NGINX which reverse proxy all of the traffic to freeCodeCamp.org from various applications running on their own infrastructures.
|
||||
|
||||
The NGINX config is available on
|
||||
[this repository](https://github.com/freeCodeCamp/nginx-config).
|
||||
The NGINX config is available on [this repository](https://github.com/freeCodeCamp/nginx-config).
|
||||
|
||||
### First Install
|
||||
|
||||
@ -443,11 +426,9 @@ Provisioning VMs with the Code
|
||||
|
||||
#### 1. (Optional) Install NGINX and configure from repository.
|
||||
|
||||
The basic setup should be ready OOTB, via the cloud-init configuration. SSH and
|
||||
make changes as necessary for the particular instance(s).
|
||||
The basic setup should be ready OOTB, via the cloud-init configuration. SSH and make changes as necessary for the particular instance(s).
|
||||
|
||||
If you did not use the cloud-init config previously use the below for manual
|
||||
setup of NGINX and error pages:
|
||||
If you did not use the cloud-init config previously use the below for manual setup of NGINX and error pages:
|
||||
|
||||
```console
|
||||
sudo su
|
||||
@ -464,8 +445,7 @@ cd /etc/nginx
|
||||
|
||||
#### 2. Install Cloudflare origin certificates and upstream application config.
|
||||
|
||||
Get the Cloudflare origin certificates from the secure storage and install at
|
||||
required locations.
|
||||
Get the Cloudflare origin certificates from the secure storage and install at required locations.
|
||||
|
||||
**OR**
|
||||
|
||||
@ -495,8 +475,7 @@ Configure Azure firewalls and `ufw` as needed for ingress origin addresses.
|
||||
|
||||
#### 4. Add the VM to the load balancer backend pool.
|
||||
|
||||
Configure and add rules to load balancer if needed. You may also need to add the
|
||||
VMs to load balancer backend pool if needed.
|
||||
Configure and add rules to load balancer if needed. You may also need to add the VMs to load balancer backend pool if needed.
|
||||
|
||||
### Logging and Monitoring
|
||||
|
||||
@ -509,11 +488,9 @@ sudo systemctl status nginx
|
||||
2. Logging and monitoring for the servers are available at:
|
||||
|
||||
> <h3 align="center"><a href='https://amplify.nginx.com' _target='blank'>https://amplify.nginx.com</a></h3>
|
||||
|
||||
### Updating Instances (Maintenance)
|
||||
|
||||
Config changes to our NGINX instances are maintained on GitHub, these should be
|
||||
deployed on each instance like so:
|
||||
Config changes to our NGINX instances are maintained on GitHub, these should be deployed on each instance like so:
|
||||
|
||||
1. SSH into the instance and enter sudo
|
||||
|
||||
@ -529,8 +506,7 @@ git fetch --all --prune
|
||||
git reset --hard origin/main
|
||||
```
|
||||
|
||||
3. Test and reload the config
|
||||
[with Signals](https://docs.nginx.com/nginx/admin-guide/basic-functionality/runtime-control/#controlling-nginx).
|
||||
3. Test and reload the config [with Signals](https://docs.nginx.com/nginx/admin-guide/basic-functionality/runtime-control/#controlling-nginx).
|
||||
|
||||
```console
|
||||
nginx -t
|
||||
@ -603,12 +579,9 @@ pm2 monit
|
||||
|
||||
### Updating Instances (Maintenance)
|
||||
|
||||
Code changes need to be deployed to the API instances from time to time. It can
|
||||
be a rolling update or a manual update. The later is essential when changing
|
||||
dependencies or adding enviroment variables.
|
||||
Code changes need to be deployed to the API instances from time to time. It can be a rolling update or a manual update. The later is essential when changing dependencies or adding enviroment variables.
|
||||
|
||||
> [!DANGER] The automated pipelines are not handling dependencies updates at the
|
||||
> minute. We need to do a manual update before any deployment pipeline runs.
|
||||
> [!DANGER] The automated pipelines are not handling dependencies updates at the minute. We need to do a manual update before any deployment pipeline runs.
|
||||
|
||||
#### 1. Manual Updates - Used for updating dependencies, env variables.
|
||||
|
||||
@ -642,8 +615,7 @@ pm2 start all --update-env && pm2 logs
|
||||
pm2 reload all --update-env && pm2 logs
|
||||
```
|
||||
|
||||
> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You
|
||||
> should not need to run these commands. These are here for documentation.
|
||||
> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You should not need to run these commands. These are here for documentation.
|
||||
|
||||
## Work on Client Instances
|
||||
|
||||
@ -681,12 +653,11 @@ Provisioning VMs with the Code
|
||||
cd client
|
||||
```
|
||||
|
||||
Start placeholder instances for the web client, these will be updated with
|
||||
artifacts from the Azure pipeline.
|
||||
Start placeholder instances for the web client, these will be updated with artifacts from the Azure pipeline.
|
||||
|
||||
> Todo: This setup needs to move to S3 or Azure Blob storage
|
||||
|
||||
```console
|
||||
> Todo: This setup needs to move to S3 or Azure Blob storage
|
||||
>
|
||||
> ```console
|
||||
echo "serve -c ../../serve.json www -p 50505" >> client-start-primary.sh
|
||||
chmod +x client-start-primary.sh
|
||||
pm2 delete client-primary
|
||||
@ -695,7 +666,7 @@ Provisioning VMs with the Code
|
||||
chmod +x client-start-secondary.sh
|
||||
pm2 delete client-secondary
|
||||
pm2 start ./client-start-secondary.sh --name client-secondary
|
||||
```
|
||||
```
|
||||
|
||||
### Logging and Monitoring
|
||||
|
||||
@ -709,12 +680,9 @@ pm2 monit
|
||||
|
||||
### Updating Instances (Maintenance)
|
||||
|
||||
Code changes need to be deployed to the API instances from time to time. It can
|
||||
be a rolling update or a manual update. The later is essential when changing
|
||||
dependencies or adding enviroment variables.
|
||||
Code changes need to be deployed to the API instances from time to time. It can be a rolling update or a manual update. The later is essential when changing dependencies or adding enviroment variables.
|
||||
|
||||
> [!DANGER] The automated pipelines are not handling dependencies updates at the
|
||||
> minute. We need to do a manual update before any deployment pipeline runs.
|
||||
> [!DANGER] The automated pipelines are not handling dependencies updates at the minute. We need to do a manual update before any deployment pipeline runs.
|
||||
|
||||
#### 1. Manual Updates - Used for updating dependencies, env variables.
|
||||
|
||||
@ -738,5 +706,4 @@ dependencies or adding enviroment variables.
|
||||
pm2 reload all --update-env && pm2 logs
|
||||
```
|
||||
|
||||
> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You
|
||||
> should not need to run these commands. These are here for documentation.
|
||||
> [!NOTE] We are handling rolling updates to code, logic, via pipelines. You should not need to run these commands. These are here for documentation.
|
||||
|
||||
@ -14,8 +14,7 @@ To learn how to write Cypress tests, or 'specs', please see Cypress' official [d
|
||||
|
||||
## How to run tests
|
||||
|
||||
> [!NOTE]
|
||||
> If using GitPod, please see [Cypress-GitPod Setup](/how-to-add-cypress-tests#cypress-gitpod-setup)
|
||||
> [!NOTE] If using GitPod, please see [Cypress-GitPod Setup](/how-to-add-cypress-tests#cypress-gitpod-setup)
|
||||
|
||||
### 1. Ensure that MongoDB and client applications are running
|
||||
|
||||
|
||||
@ -83,15 +83,15 @@ Start [using MailHog](#using-mailhog).
|
||||
|
||||
Open a new browser tab or window and navigate to [http://localhost:8025](http://localhost:8025) to open your MailHog inbox when the MailHog installation has completed and MailHog is running. The inbox will appear similar to the screenshot below.
|
||||
|
||||
|
||||
|
||||
|
||||
Emails sent by your freeCodeCamp installation will appear as below
|
||||
|
||||
|
||||
|
||||
|
||||
Two tabs that allow you to view either plain text or source content will be available when you open a given email. Ensure that the plain text tab is selected as below.
|
||||
|
||||
|
||||
|
||||
|
||||
All links in the email should be clickable and resolve to their URL.
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ Challenge description text, in markdown
|
||||
<div>
|
||||
example code
|
||||
</div>
|
||||
```
|
||||
````
|
||||
|
||||
# --question--
|
||||
|
||||
@ -76,11 +76,9 @@ Pick a challenge markdown file from the options above.
|
||||
First, find the videoId.
|
||||
|
||||
For example, in the following code from the header of a video challenge markdown file, the videoId is "nVAaxZ34khk". On GitHub, the information should be laid out in a table format.
|
||||
```
|
||||
````
|
||||
---
|
||||
id: 5e9a093a74c4063ca6f7c14d
|
||||
title: Data Analysis Example A
|
||||
challengeType: 11
|
||||
id: 5e9a093a74c4063ca6f7c14d title: Data Analysis Example A challengeType: 11
|
||||
videoId: nVAaxZ34khk
|
||||
---
|
||||
```
|
||||
@ -139,7 +137,7 @@ Add/Update answers (`Answer 1`, `Answer 2`, and so on) under `## --answers--`. M
|
||||
What does this JavaScript code log to the console?
|
||||
```js
|
||||
console.log('hello world');
|
||||
```
|
||||
````
|
||||
|
||||
## --answers--
|
||||
|
||||
@ -171,7 +169,7 @@ What will print out after running this code:
|
||||
width = 15
|
||||
height = 12.0
|
||||
print(height/3)
|
||||
```
|
||||
````
|
||||
|
||||
## --answers--
|
||||
|
||||
@ -195,8 +193,7 @@ print(height/3)
|
||||
|
||||
## --video-solution--
|
||||
|
||||
3
|
||||
````
|
||||
3 ````
|
||||
|
||||
For more examples, you can look at the markdown files for the following video course. All the challenges already have questions: [Python for Everybody Course](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/curriculum/challenges/english/07-scientific-computing-with-python/python-for-everybody)
|
||||
|
||||
|
||||
@ -2,29 +2,28 @@
|
||||
|
||||
A pull request (PR) enables you to send changes from your fork on GitHub to freeCodeCamp.org's main repository. Once you are done making changes to the code, you can follow these guidelines to open a PR.
|
||||
|
||||
> [!NOTE]
|
||||
> Your PR should be in English. See [here](#index.md?id=translations) for how to contribute translations.
|
||||
> [!NOTE] Your PR should be in English. See [here](#index.md?id=translations) for how to contribute translations.
|
||||
|
||||
## Prepare a good PR title
|
||||
|
||||
We recommend using [conventional title and messages](https://www.conventionalcommits.org/) for commits and pull request. The convention has the following format:
|
||||
|
||||
> `<type>([optional scope(s)]): <description>`
|
||||
>
|
||||
>
|
||||
> For example:
|
||||
>
|
||||
>
|
||||
> `fix(learn): tests for the do...while loop challenge`
|
||||
|
||||
When opening a Pull Request(PR), you can use the below to determine the type, scope (optional), and description.
|
||||
|
||||
**Type:**
|
||||
|
||||
| Type | When to select |
|
||||
| :---- | :--------------------------------------------------------------------------- |
|
||||
| Type | When to select |
|
||||
|:----- |:-------------------------------------------------------------------------------- |
|
||||
| fix | Changed or updated/improved functionality, tests, the verbiage of a lesson, etc. |
|
||||
| feat | Only if you are adding new functionality, tests, etc. |
|
||||
| chore | Changes that are not related to code, tests, or verbiage of a lesson. |
|
||||
| docs | Changes to `/docs` directory or the contributing guidelines, etc. |
|
||||
| feat | Only if you are adding new functionality, tests, etc. |
|
||||
| chore | Changes that are not related to code, tests, or verbiage of a lesson. |
|
||||
| docs | Changes to `/docs` directory or the contributing guidelines, etc. |
|
||||
|
||||
**Scope:**
|
||||
|
||||
@ -45,13 +44,13 @@ Some examples of good PRs titles would be:
|
||||
|
||||
1. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page.
|
||||
|
||||
|
||||
|
||||
|
||||
2. By default, all pull requests should be against the freeCodeCamp main repo, `main` branch.
|
||||
|
||||
Make sure that your Base Fork is set to freeCodeCamp/freeCodeCamp when raising a Pull Request.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Submit the pull request from your branch to freeCodeCamp's `main` branch.
|
||||
|
||||
@ -61,8 +60,7 @@ Some examples of good PRs titles would be:
|
||||
|
||||
- Fill in the details as you see fit. This information will be reviewed and the reviewers will decide whether or not your pull request is accepted.
|
||||
|
||||
- If the PR is meant to address an existing GitHub Issue then, at the end of
|
||||
your PR's description body, use the keyword _Closes_ with the issue number to [automatically close that issue if the PR is accepted and merged](https://help.github.com/en/articles/closing-issues-using-keywords).
|
||||
- If the PR is meant to address an existing GitHub Issue then, at the end of your PR's description body, use the keyword _Closes_ with the issue number to [automatically close that issue if the PR is accepted and merged](https://help.github.com/en/articles/closing-issues-using-keywords).
|
||||
|
||||
> Example: `Closes #123` will close issue 123
|
||||
|
||||
@ -80,8 +78,7 @@ Our moderators will now take a look and leave you feedback. Please be patient wi
|
||||
|
||||
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [the contributors chat room](https://chat.freecodecamp.org/channel/contributors).
|
||||
|
||||
> [!TIP]
|
||||
> If you are to be contributing more pull requests, we recommend you read the [making changes and syncing](https://contribute.freecodecamp.org/#/how-to-setup-freecodecamp-locally?id=making-changes-locally) guidelines to avoid having to delete your fork.
|
||||
> [!TIP] If you are to be contributing more pull requests, we recommend you read the [making changes and syncing](https://contribute.freecodecamp.org/#/how-to-setup-freecodecamp-locally?id=making-changes-locally) guidelines to avoid having to delete your fork.
|
||||
|
||||
## Conflicts on a pull request
|
||||
|
||||
|
||||
@ -8,16 +8,15 @@ To begin proofreading, visit [our translation site](https://translate.freecodeca
|
||||
|
||||
You should see the list of projects you have been granted access to. Select the project that you would like to proofread, then select the language.
|
||||
|
||||
|
||||
|
||||
|
||||
You should now see the list of available files. Choose your file by selecting the `Proofread` button on the right of that file, then choosing `Proofreading` from the drop-down menu that appears.
|
||||
|
||||
> [!NOTE]
|
||||
> If you are in this workspace view, but want to work on [translating a file](./how-to-translate-files.md) instead of proofreading, you may select `Crowdsourcing` from the dropdown menu instead.
|
||||
> [!NOTE] If you are in this workspace view, but want to work on [translating a file](./how-to-translate-files.md) instead of proofreading, you may select `Crowdsourcing` from the dropdown menu instead.
|
||||
|
||||
## Proofread Translations
|
||||
|
||||
|
||||
|
||||
|
||||
<!--Add proofread/crowdsource button to the image-->
|
||||
|
||||
@ -34,10 +33,8 @@ While you can view *all* proposed translations for a given string, the community
|
||||
7. This button shows/hides the right-hand side display pane, where you can view translations, comments, translation memory, and glossary terms.
|
||||
8. Crowdin displays error messages here from the quality assurance checks. In other words, if something does not seem correct in the translation, Crowdin will notify you. These translations should be approved with care.
|
||||
|
||||
> [!WARNING]
|
||||
> Approving a string in the proofreading view will mark it as complete and it will be downloaded in our next pull from Crowdin to GitHub.
|
||||
> [!WARNING] Approving a string in the proofreading view will mark it as complete and it will be downloaded in our next pull from Crowdin to GitHub.
|
||||
|
||||
No additional actions are required once a file has been proofread. If you have any questions, or are interested in becoming a proofreader, feel free to reach out to us in our [translators chat room](https://chat.freecodecamp.org/channel/translators).
|
||||
|
||||
> [!NOTE]
|
||||
> Crowdin will allow you to approve your translations. In general, it is best to allow another proofreader to review your proposed translations as extra safety to ensure there are no errors.
|
||||
> [!NOTE] Crowdin will allow you to approve your translations. In general, it is best to allow another proofreader to review your proposed translations as extra safety to ensure there are no errors.
|
||||
|
||||
@ -2,11 +2,10 @@ Follow these guidelines for setting up freeCodeCamp locally on your system. This
|
||||
|
||||
Some of these contribution workflows – like fixing bugs in the codebase or curriculum – need you to run freeCodeCamp locally on your computer.
|
||||
|
||||
> [!TIP]
|
||||
> If you are not interested in setting up freeCodeCamp locally, consider using Gitpod, a free online dev environment.
|
||||
>
|
||||
> [!TIP] If you are not interested in setting up freeCodeCamp locally, consider using Gitpod, a free online dev environment.
|
||||
>
|
||||
> [](https://gitpod.io/#https://github.com/freeCodeCamp/freeCodeCamp)
|
||||
>
|
||||
>
|
||||
> (Starts a ready-to-code dev environment for freeCodeCamp in your browser.)
|
||||
|
||||
### How to prepare your local machine
|
||||
@ -21,14 +20,13 @@ Some community members also develop on Windows 10 natively with Git for Windows
|
||||
|
||||
**Prerequisites:**
|
||||
|
||||
| Prerequisite | Version | Notes |
|
||||
| ----------------------------- | ------- | -------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `12.x` | [LTS Schedule](https://github.com/nodejs/Release#release-schedule) |
|
||||
| npm (comes bundled with Node) | `6.x` | Does not have LTS releases, we use the version bundled with Node LTS |
|
||||
| Prerequisite | Version | Notes |
|
||||
| --------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [Node.js](http://nodejs.org) | `12.x` | [LTS Schedule](https://github.com/nodejs/Release#release-schedule) |
|
||||
| npm (comes bundled with Node) | `6.x` | Does not have LTS releases, we use the version bundled with Node LTS |
|
||||
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `3.6` | [Release Notes](https://docs.mongodb.com/manual/release-notes/), Note: We are currently on `3.6`, an [upgrade is planned](https://github.com/freeCodeCamp/freeCodeCamp/issues/18275). |
|
||||
|
||||
> [!DANGER]
|
||||
> If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
> [!DANGER] If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting](#troubleshooting) for details.
|
||||
|
||||
If Node.js is already installed on your machine, run the following commands to validate the versions:
|
||||
|
||||
@ -37,8 +35,7 @@ node -v
|
||||
npm -v
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
> [!TIP] We highly recommend updating to the latest stable releases of the software listed above, also known as Long Term Support (LTS) releases.
|
||||
|
||||
Once you have the prerequisites installed, you need to prepare your development environment. This is common for many development workflows, and you will only need to do this once.
|
||||
|
||||
@ -56,8 +53,7 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
You should have [ESLint running in your editor](http://eslint.org/docs/user-guide/integrations.html), and it will highlight anything that doesn't conform to [freeCodeCamp's JavaScript Style Guide](http://forum.freecodecamp.org/t/free-code-camp-javascript-style-guide/19121).
|
||||
|
||||
> [!TIP]
|
||||
> Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
> [!TIP] Please do not ignore any linting errors. They are meant to **help** you and to ensure a clean and simple codebase.
|
||||
|
||||
## Fork the repository on GitHub
|
||||
|
||||
@ -65,9 +61,8 @@ Once you have the prerequisites installed, you need to prepare your development
|
||||
|
||||
This is essential, as it allows you to work on your own copy of freeCodeCamp on GitHub, or to download (clone) your repository to work on locally. Later, you will be able to request changes to be pulled into the main repository from your fork via a pull request (PR).
|
||||
|
||||
> [!TIP]
|
||||
> The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> [!TIP] The main repository at `https://github.com/freeCodeCamp/freeCodeCamp` is often referred to as the `upstream` repository.
|
||||
>
|
||||
> Your fork at `https://github.com/YOUR_USER_NAME/freeCodeCamp` is often referred to as the `origin` repository. `YOUR_USER_NAME` would be replaced with your GitHub username.
|
||||
|
||||
**Follow these steps to fork the `https://github.com/freeCodeCamp/freeCodeCamp` repository:**
|
||||
@ -82,18 +77,17 @@ This is essential, as it allows you to work on your own copy of freeCodeCamp on
|
||||
<summary>
|
||||
How to fork freeCodeCamp on GitHub (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub">
|
||||
<img src="https://raw.githubusercontent.com/freeCodeCamp/freeCodeCamp/main/docs/images/github/how-to-fork-freeCodeCamp.gif" alt="How to fork freeCodeCamp on GitHub" />
|
||||
</details>
|
||||
|
||||
## Clone your fork from GitHub
|
||||
|
||||
[Cloning](https://help.github.com/articles/cloning-a-repository/) is where you **download** a copy of a repository from a `remote` location that is either owned by you or by someone else. In your case, this remote location is your `fork` of freeCodeCamp's repository that should be available at `https://github.com/YOUR_USER_NAME/freeCodeCamp`. (`YOUR_USER_NAME` would be replaced with your GitHub user name.)
|
||||
|
||||
> [!WARNING]
|
||||
> If you are working on a WSL2 Linux Distro, you might get performance and stability issues by running this project in a folder which is shared between Windows and WSL2 (e.g. `/mnt/c/Users/`).
|
||||
> Therefore we recommend to clone this repo into a folder which is mainly used by your WSL2 Linux Distro and not directly shared with Windows (e.g. `~/PROJECTS/`).
|
||||
>
|
||||
> [!WARNING] If you are working on a WSL2 Linux Distro, you might get performance and stability issues by running this project in a folder which is shared between Windows and WSL2 (e.g. `/mnt/c/Users/`). Therefore we recommend to clone this repo into a folder which is mainly used by your WSL2 Linux Distro and not directly shared with Windows (e.g. `~/PROJECTS/`).
|
||||
>
|
||||
> See [this GitHub Issue](https://github.com/freeCodeCamp/freeCodeCamp/issues/40632) for further Information about this problem.
|
||||
|
||||
Run these commands on your local machine:
|
||||
@ -159,11 +153,10 @@ If you do run into issues, first perform a web search for your issue and see if
|
||||
|
||||
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [our chat server](https://chat.freecodecamp.org/home).
|
||||
|
||||
> [!TIP]
|
||||
> You may skip running freeCodeCamp locally if you are simply editing files. For instance, performing a `rebase`, or resolving `merge` conflicts.
|
||||
>
|
||||
> [!TIP] You may skip running freeCodeCamp locally if you are simply editing files. For instance, performing a `rebase`, or resolving `merge` conflicts.
|
||||
>
|
||||
> You can always return to this part of the instructions later. You should **only** skip this step if you do not need to run the apps on your machine.
|
||||
>
|
||||
>
|
||||
> [Skip to making changes](#making-changes-locally).
|
||||
|
||||
### Configuring dependencies
|
||||
@ -185,8 +178,7 @@ copy sample.env .env
|
||||
|
||||
The keys in the `.env` file are _not_ required to be changed to run the app locally. You can leave the default values copied over from `sample.env` as-is.
|
||||
|
||||
> [!TIP]
|
||||
> Keep in mind if you want to use services like Auth0 or Algolia, you'll have to acquire your own API keys for those services and edit the entries accordingly in the `.env` file.
|
||||
> [!TIP] Keep in mind if you want to use services like Auth0 or Algolia, you'll have to acquire your own API keys for those services and edit the entries accordingly in the `.env` file.
|
||||
|
||||
#### Step 2: Install dependencies
|
||||
|
||||
@ -200,8 +192,7 @@ npm ci
|
||||
|
||||
Before you can run the application locally, you will need to start the MongoDB service.
|
||||
|
||||
> [!NOTE]
|
||||
> Unless you have MongoDB running in a setup different than the default, the URL stored as the `MONGOHQ_URL` value in the `.env` file should work fine. If you are using a custom configuration, modify this value as needed.
|
||||
> [!NOTE] Unless you have MongoDB running in a setup different than the default, the URL stored as the `MONGOHQ_URL` value in the `.env` file should work fine. If you are using a custom configuration, modify this value as needed.
|
||||
|
||||
Start the MongoDB server in a separate terminal:
|
||||
|
||||
@ -219,8 +210,7 @@ Start the MongoDB server in a separate terminal:
|
||||
|
||||
Make sure to replace `3.6` with the version you have installed
|
||||
|
||||
> [!TIP]
|
||||
> You can avoid having to start MongoDB every time by installing it as a background service. You can [learn more about it in their documentation for your OS](https://docs.mongodb.com/manual/administration/install-community/)
|
||||
> [!TIP] You can avoid having to start MongoDB every time by installing it as a background service. You can [learn more about it in their documentation for your OS](https://docs.mongodb.com/manual/administration/install-community/)
|
||||
|
||||
Next, let's seed the database. In this step, we run the below command that fills the MongoDB server with some initial data sets that are required by services. These include a few schemas, among other things.
|
||||
|
||||
@ -238,11 +228,9 @@ npm run develop
|
||||
|
||||
This single command will fire up all the services, including the API server and the client applications available for you to work on.
|
||||
|
||||
> [!NOTE]
|
||||
> Once ready, open a web browser and **visit <http://localhost:8000>**. If the app loads, congratulations – you're all set! You now have a copy of freeCodeCamp's entire learning platform running on your local machine.
|
||||
> [!NOTE] Once ready, open a web browser and **visit <http://localhost:8000>**. If the app loads, congratulations – you're all set! You now have a copy of freeCodeCamp's entire learning platform running on your local machine.
|
||||
|
||||
> [!TIP]
|
||||
> The API Server serves APIs at `http://localhost:3000`. The Gatsby app serves the client application at `http://localhost:8000`
|
||||
> [!TIP] The API Server serves APIs at `http://localhost:3000`. The Gatsby app serves the client application at `http://localhost:8000`
|
||||
|
||||
> If you visit <http://localhost:3000/explorer> you should see the available APIs.
|
||||
|
||||
@ -258,8 +246,9 @@ Simply clicking the **"Preview Custom 404 Page"** button will forward you to the
|
||||
<summary>
|
||||
How to sign in when working locally (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://user-images.githubusercontent.com/29990697/71541249-f63cdf00-2923-11ea-8a85-cefb6f9c9977.gif" alt="How to sign in when working locally">
|
||||
<img src="https://user-images.githubusercontent.com/29990697/71541249-f63cdf00-2923-11ea-8a85-cefb6f9c9977.gif" alt="How to sign in when working locally" />
|
||||
</details>
|
||||
|
||||
## Making changes locally
|
||||
@ -291,9 +280,8 @@ Follow these steps:
|
||||
|
||||
2. Sync the latest changes from the freeCodeCamp upstream `main` branch to your local main branch:
|
||||
|
||||
> [!WARNING]
|
||||
> If you have any outstanding pull request that you made from the `main` branch of your fork, you will lose them at the end of this step.
|
||||
>
|
||||
> [!WARNING] If you have any outstanding pull request that you made from the `main` branch of your fork, you will lose them at the end of this step.
|
||||
>
|
||||
> You should ensure your pull request is merged by a moderator before performing this step. To avoid this scenario, you should **always** work on a branch other than the `main`.
|
||||
|
||||
This step **will sync the latest changes** from the main repository of freeCodeCamp. It is important that you rebase your branch on top of the latest `upstream/main` as often as possible to avoid conflicts later.
|
||||
@ -490,7 +478,7 @@ It is recommended to research your specific issue on resources such as Google, S
|
||||
If you are on a different OS and/or are still running into issues, see [getting help](#getting-help).
|
||||
|
||||
> [!WARNING]
|
||||
>
|
||||
>
|
||||
> Please avoid creating GitHub issues for prerequisite issues. They are out of the scope of this project.
|
||||
|
||||
### Issues with the UI, Fonts, build errors, etc.
|
||||
@ -524,8 +512,9 @@ git clean -ifdX
|
||||
<summary>
|
||||
How to clean git untracked files (screenshot)
|
||||
</summary>
|
||||
|
||||
<br>
|
||||
<img src="https://user-images.githubusercontent.com/1884376/94270515-ca579400-ff5d-11ea-8ff1-152cade31654.gif" alt="How to clean git untracked files">
|
||||
<img src="https://user-images.githubusercontent.com/1884376/94270515-ca579400-ff5d-11ea-8ff1-152cade31654.gif" alt="How to clean git untracked files" />
|
||||
</details>
|
||||
|
||||
### Issues with API, login, Challenge Submissions, etc.
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
# Set up freeCodeCamp on Windows Subsystem for Linux (WSL)
|
||||
|
||||
> [!NOTE]
|
||||
> Before you follow these instructions make sure your system meets the requirements
|
||||
>
|
||||
> [!NOTE] Before you follow these instructions make sure your system meets the requirements
|
||||
>
|
||||
> **WSL 2**: Windows 10 64-bit (Version 2004, Build 19041 or higher) - available for all distributions including Windows 10 Home.
|
||||
>
|
||||
>
|
||||
> **Docker Desktop for Windows**: See respective requirements for [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/#system-requirements) and [Windows 10 Home](https://docs.docker.com/docker-for-windows/install-windows-home/#system-requirements)
|
||||
|
||||
This guide covers some common steps with the setup of WSL2. Once some of the common issues with WSL2 are addressed, you should be able to follow the our local setup guide to work with freeCodeCamp on Windows running a WSL distro like Ubuntu.
|
||||
@ -18,7 +17,7 @@ Follow the instructions on the [official documentation](https://docs.microsoft.c
|
||||
1. We recommended using Ubuntu-18.04 or above with WSL2.
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
>
|
||||
> While you may use other non-debian based distros, they all come with their own gotchas and are beyond the scope of this guide.
|
||||
|
||||
2. Update the dependencies for the OS
|
||||
@ -119,7 +118,7 @@ npm install -g npm@latest
|
||||
Now that you have installed the pre-requisites, follow [our local setup guide](https://contribute.freecodecamp.org/#/how-to-setup-freecodecamp-locally) to clone, install and setup freeCodeCamp locally on your machine.
|
||||
|
||||
> [!WARNING]
|
||||
>
|
||||
>
|
||||
> Please note, at this time the set up for Cypress tests (and related GUI needs) are a work in progress. You should still be able to work on most of the codebase.
|
||||
|
||||
## Useful Links
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
# How to Translate a File
|
||||
|
||||
> [!NOTE]
|
||||
> All translations are handled through https://translate.freecodecamp.org - we are no longer using GitHub to translate files directly.
|
||||
> [!NOTE] All translations are handled through https://translate.freecodecamp.org - we are no longer using GitHub to translate files directly.
|
||||
|
||||
To begin, head to our translation website and login (if you have not contributed to translations before, you will need to create an account).
|
||||
|
||||
@ -11,22 +10,21 @@ You should see two "projects" available for translation: The `Contributing Docum
|
||||
|
||||
Select which project you want to contribute to, and you will see a list of available languages for translation.
|
||||
|
||||
|
||||
|
||||
|
||||
Select the language you want to work on, and you will see the complete file tree.
|
||||
|
||||
|
||||
|
||||
|
||||
Each file and folder will show a progress bar. The **blue** portion of the progress bar indicates what percentage of the file has been translated, while the **green** portion of the progress bar indicates what percentage of the file has been approved by the proofreading team.
|
||||
|
||||
Select a file to work on and Crowdin will open the editor view.
|
||||
|
||||
> [!NOTE]
|
||||
> When the editor view opens, you will need to click the settings icon (shown as a gear) and switch the 'HTML tags displaying' setting to 'SHOW'. This will ensure you can see tags such as `<code></code>` instead of `<0></0>`.
|
||||
> [!NOTE] When the editor view opens, you will need to click the settings icon (shown as a gear) and switch the 'HTML tags displaying' setting to 'SHOW'. This will ensure you can see tags such as `<code></code>` instead of `<0></0>`.
|
||||
|
||||
## Translate the File
|
||||
|
||||
|
||||
|
||||
|
||||
Crowdin separates a document into translatable "strings", usually sentences. Each string is translated individually. Referring to the image above:
|
||||
|
||||
@ -41,22 +39,19 @@ Crowdin separates a document into translatable "strings", usually sentences. Eac
|
||||
9. Here you can see the comments window. If you have questions or concerns about a particular string, you can leave a comment on the string here for other translators to see.
|
||||
10. These two "pane" buttons will hide the left (document) and right (comments) views.
|
||||
|
||||
> [!NOTE]
|
||||
> If you see a hidden string that includes translations, please notify us in the [translators chat room](https://chat.freecodecamp.org/channel/translators) so we can remove the translation from memory.
|
||||
> [!NOTE] If you see a hidden string that includes translations, please notify us in the [translators chat room](https://chat.freecodecamp.org/channel/translators) so we can remove the translation from memory.
|
||||
|
||||
When you have completed a translation for a string, select the `Save` button to store your translation on Crowdin. Other contributors will then be able to vote on your translation and proofreaders will be able to approve it.
|
||||
|
||||
You are welcome to translate as many strings as you like - there are no additional steps required when you complete a full file or propose a new translation. Clicking the `Save` button is all that is needed to store a translation.
|
||||
|
||||
> [!NOTE]
|
||||
> If you see something in the English source file that is inaccurate or incorrect, please do not fix it through the translation flow. Instead, leave a comment on the string to notify us that there is a discrepancy, or create a GitHub issue.
|
||||
> [!NOTE] If you see something in the English source file that is inaccurate or incorrect, please do not fix it through the translation flow. Instead, leave a comment on the string to notify us that there is a discrepancy, or create a GitHub issue.
|
||||
|
||||
### Translating Documentation
|
||||
|
||||
Translating our contributing documentation is a similar flow to translating our curriculum files.
|
||||
|
||||
> [!NOTE]
|
||||
> Our contributing documentation is powered by `docsify`, and we have special parsing for message boxes like this one. If you see strings that start with `[!NOTE]`, `[!WARNING]`, or `[!TIP]`, these words should NOT be translated.
|
||||
> [!NOTE] Our contributing documentation is powered by `docsify`, and we have special parsing for message boxes like this one. If you see strings that start with `[!NOTE]`, `[!WARNING]`, or `[!TIP]`, these words should NOT be translated.
|
||||
|
||||
## Rate Translations
|
||||
|
||||
@ -72,12 +67,11 @@ We have enabled some quality assurance steps that will verify a translation is a
|
||||
|
||||
When you attempt to save a translation, you may see a warning message appear with a notification regarding your proposed translation.
|
||||
|
||||
|
||||
|
||||
|
||||
This message appears when Crowdin's QA system has identified a potential error in the proposed translation. In this example, we have modified the text of a `<code>` tag and Crowdin has caught that.
|
||||
|
||||
> [!WARNING]
|
||||
> You have the option to save a translation in spite of errors. If you do, by clicking "Save Anyway", you should also tag a proofreader or project manager and explain why the QA message needs to be ignored in this case.
|
||||
> [!WARNING] You have the option to save a translation in spite of errors. If you do, by clicking "Save Anyway", you should also tag a proofreader or project manager and explain why the QA message needs to be ignored in this case.
|
||||
|
||||
## Translation Best Practices
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
The client/react side of our website is translated into various world languages using [react-i18next](https://react.i18next.com/) and [i18next](https://www.i18next.com/).
|
||||
|
||||
> [!NOTE]
|
||||
> Curriculum lesson content is [translated separately](./how-to-translate-files.md).
|
||||
> [!NOTE] Curriculum lesson content is [translated separately](./how-to-translate-files.md).
|
||||
|
||||
## File Structure
|
||||
|
||||
@ -21,7 +20,7 @@ The `meta-tags.json` file contains the information for our website's meta tag in
|
||||
|
||||
To add a new language, create a folder with the language name as the title next to the other languages and copy the JSON files from another language into your new folder.
|
||||
|
||||
In the `all-langs.js` file, add the language to the `client` array in the first variable. Then, follow the instructions in the comments to add the rest of the necessary variables.
|
||||
In the `allLangs.js` file, add the language to the `client` array in the first variable. Then, follow the instructions in the comments to add the rest of the necessary variables.
|
||||
|
||||
## How to Translate
|
||||
|
||||
@ -33,8 +32,7 @@ Modifications to the `trending.json`, `meta-tags.json`, and `motivation.json` fi
|
||||
|
||||
Set the `CLIENT_LOCALE` variable in your `.env` file to the locale you want to build.
|
||||
|
||||
> [!NOTE]
|
||||
> The value needs to be one of the client languages available in `config/i18n/all-langs.js`
|
||||
> [!NOTE] The value needs to be one of the client languages available in `client/i18n/allLangs.js`
|
||||
|
||||
## How to Structure Components
|
||||
|
||||
@ -190,13 +188,11 @@ If the text you want to add to the client exists in the relevant `.json` file, u
|
||||
|
||||
The English file is the "source of truth" for all of the `.json` files sharing the same name. If you need to add a new key, add it there. Then, add the key to **all** of the `translations.json` files.
|
||||
|
||||
> [!NOTE]
|
||||
> Use English text for all languages if the file is translated through Crowdin. The tests will fail if you don't.
|
||||
> [!NOTE] Use English text for all languages if the file is translated through Crowdin. The tests will fail if you don't.
|
||||
|
||||
It would be nice to keep the keys in the same order across all the files as well. Also, try to put all punctuation, spacing, quotes, etc in the JSON files and not in the components or server files.
|
||||
It would be nice to keep the keys in the same order across all the files as well. Also, try to put all punctuation, spacing, quotes, etc in the JSON files and not in the components or server files.
|
||||
|
||||
> [!NOTE]
|
||||
> The underscore (`_`) is a reserved character for keys in the client side files. See [the documentation](https://www.i18next.com/translation-function/plurals) for how they are used.
|
||||
> [!NOTE] The underscore (`_`) is a reserved character for keys in the client side files. See [the documentation](https://www.i18next.com/translation-function/plurals) for how they are used.
|
||||
|
||||
## Helpful Documentation
|
||||
|
||||
|
||||
@ -49,7 +49,7 @@ Challenge description text, in markdown
|
||||
<div>
|
||||
example code
|
||||
</div>
|
||||
```
|
||||
````
|
||||
|
||||
# --instructions--
|
||||
|
||||
@ -184,7 +184,7 @@ MongoDB server version: 3.4.10
|
||||
...
|
||||
$ ObjectId()
|
||||
ObjectId("5a474d78df58bafeb3535d34")
|
||||
```
|
||||
````
|
||||
|
||||
The result is a new id, for example `5a474d78df58bafeb3535d34` above.
|
||||
|
||||
@ -202,7 +202,7 @@ Naming things is hard. We've made it easier by imposing some constraints.
|
||||
|
||||
All challenge titles should be explicit and should follow this pattern:
|
||||
|
||||
[verb][object clause]
|
||||
\[verb\]\[object clause\]
|
||||
|
||||
Here are some example challenge names:
|
||||
|
||||
@ -255,14 +255,14 @@ Our goal is to have thousands of 2-minute challenges. These can flow together an
|
||||
|
||||
Here are specific formatting guidelines for challenge text and examples:
|
||||
|
||||
- Language keywords go in `\`` backticks. For example, HTML tag names or CSS property names.
|
||||
- References to code parts (i.e. function, method, or variable names) should be wrapped in `\`` backticks. See example below:
|
||||
- Language keywords go in `` \` `` backticks. For example, HTML tag names or CSS property names.
|
||||
- References to code parts (i.e. function, method, or variable names) should be wrapped in `` \` `` backticks. See example below:
|
||||
```md
|
||||
Use `parseInt` to convert the variable `realNumber` into an integer.
|
||||
```
|
||||
- References to file names and path directories (e.g. `package.json`, `src/components`) should be wrapped in `\`` backticks.
|
||||
- References to file names and path directories (e.g. `package.json`, `src/components`) should be wrapped in `` \` `` backticks.
|
||||
- Multi-line code blocks **must be preceded by an empty line**. The next line must start with three backticks followed immediately by one of the [supported languages](https://prismjs.com/#supported-languages). To complete the code block, you must start a new line which only has three backticks and **another empty line**. See example below:
|
||||
- Whitespace matters in Markdown, so we recommend that you make it visible in your editor.
|
||||
- Whitespace matters in Markdown, so we recommend that you make it visible in your editor.
|
||||
|
||||
**Note:** If you are going to use an example code in YAML, use `yaml` instead of `yml` for the language to the right of the backticks.
|
||||
|
||||
@ -272,7 +272,7 @@ The following is an example of code:
|
||||
|
||||
[YOUR CODE HERE]
|
||||
|
||||
```
|
||||
````
|
||||
````
|
||||
|
||||
- Additional information in the form of a note should be surrounded by blank lines, and formatted: `**Note:** Rest of note text...`
|
||||
@ -307,7 +307,7 @@ Example of valid single line JavaScript comment:
|
||||
|
||||
```js
|
||||
// Only change code below this line
|
||||
```
|
||||
````
|
||||
|
||||
Example of a valid CSS comment:
|
||||
|
||||
@ -363,14 +363,13 @@ class MyComponent extends React.Component {
|
||||
|
||||
There are separate comment dictionaries for each language. The [English version of the comment dictionary](/curriculum/dictionaries/english/comments.js) is the basis for the translations found in the corresponding non-English versions of the files. The non-English version of the Chinese comment dictionary would be located at `/curriculum/dictionaries/chinese/comments.js`. Each dictionary consists of an array of objects with a unique `id` property and a `text` property. Only the `text` should be modified to encompass the translation of the corresponding English comment.
|
||||
|
||||
Some comments may contain a word/phrase that should not be translated. For example, variable names or proper library names like "React" should not be translated. See the comment below as an example. The word `myGlobal` should not be translated.
|
||||
Some comments may contain a word/phrase that should not be translated. For example, variable names or proper library names like "React" should not be translated. See the comment below as an example. The word `myGlobal` should not be translated.
|
||||
|
||||
```text
|
||||
Declare the myGlobal variable below this line
|
||||
```
|
||||
|
||||
>[!NOTE]
|
||||
>
|
||||
> [!NOTE]
|
||||
>
|
||||
> We are working on an integration to make it possible to work on i18n for the comment dictionary.
|
||||
|
||||
## Hints and Solutions
|
||||
@ -384,7 +383,7 @@ If you find a problem with an existing challenge's hints/solutions topic, you ca
|
||||
Take the following steps when adding a new challenge hints/solutions related topic.
|
||||
|
||||
1. Start by following the same steps for creating a new topic but review the next for creating the title.
|
||||
2. The title of the topic should start with `freeCodeCamp Challenge Guide: ` concatenated with the actual title of the curriculum challenge. For example, if the challenge is named "`Chunky Monkey`", the topic title would be "`freeCodeCamp Challenge Guide: Chunky Monkey`".
|
||||
2. The title of the topic should start with `freeCodeCamp Challenge Guide:` concatenated with the actual title of the curriculum challenge. For example, if the challenge is named "`Chunky Monkey`", the topic title would be "`freeCodeCamp Challenge Guide: Chunky Monkey`".
|
||||
3. `camperbot` should be the owner of these topics/posts, so you will need to request an admin to change the ownership of the main post to `camperbot`.
|
||||
4. Once the new topic is created, a forum topic id is created. It is located at the end of the forum topic URL. This id must be added to the frontmatter of the curriculum challenge file via the normal pull request process for the `Get a Hint` button to link to the topic.
|
||||
|
||||
@ -428,7 +427,7 @@ Hint goes here
|
||||
function myFunc() {
|
||||
console.log('Hello World!');
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
#### Code Explanation
|
||||
|
||||
@ -449,7 +448,7 @@ Before you [create a pull request](how-to-open-a-pull-request.md) for your chang
|
||||
|
||||
1. To test all challenges run the below command from the root directory
|
||||
|
||||
```
|
||||
````
|
||||
npm run test:curriculum
|
||||
```
|
||||
|
||||
@ -474,13 +473,11 @@ You are also able to test one challenge individually by performing the following
|
||||
2. Run the following for each challenge file for which you have changed (replacing `challenge-title-goes-here` with the full title of the challenge):
|
||||
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here
|
||||
```
|
||||
npm run test -- -g challenge-title-goes-here ```
|
||||
|
||||
Once you have verified that each challenge you've worked on passes the tests, [please create a pull request](https://github.com/freeCodeCamp/freeCodeCamp/blob/main/docs/how-to-open-a-pull-request.md).
|
||||
|
||||
> [!TIP]
|
||||
> You can set the environment variable `LOCALE` in the `.env` to the language of the challenge(s) you need to test.
|
||||
> [!TIP] You can set the environment variable `LOCALE` in the `.env` to the language of the challenge(s) you need to test.
|
||||
>
|
||||
> The currently accepted values are `english` and `chinese`, with `english` being set by default.
|
||||
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
# How to work on the docs theme
|
||||
|
||||
> [!NOTE]
|
||||
> A quick reminder that you do not need to setup anything for working on the content for the documentation site.
|
||||
>
|
||||
> [!NOTE] A quick reminder that you do not need to setup anything for working on the content for the documentation site.
|
||||
>
|
||||
> To work on the contributing guidelines, you can edit or add files in the `docs` directory [available here](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs). When your changes are merged, it will be made available automatically at the documentation site.
|
||||
|
||||
## Structure of the docs website
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
The [freeCodeCamp.org](https://freecodecamp.org) community is possible thanks to thousands of kind volunteers like you. If you want to contribute your time and expertise, we would be excited to welcome you aboard.
|
||||
|
||||
> [!NOTE]
|
||||
> Before you proceed, please take a quick 2 minutes to read our [Code of Conduct](https://www.freecodecamp.org/code-of-conduct). We strictly enforce it across our community so that contributing to freeCodeCamp.org is a safe, inclusive experience for everyone.
|
||||
> [!NOTE] Before you proceed, please take a quick 2 minutes to read our [Code of Conduct](https://www.freecodecamp.org/code-of-conduct). We strictly enforce it across our community so that contributing to freeCodeCamp.org is a safe, inclusive experience for everyone.
|
||||
|
||||
Happy contributing.
|
||||
|
||||
|
||||
@ -12,8 +12,7 @@ This said you can serve as a moderator in whichever places are of the most inter
|
||||
|
||||
The bottom line is that we want you to enjoy being a moderator, and invest your scarce time in places that are of interest to you.
|
||||
|
||||
> [!NOTE]
|
||||
> "With great power comes great responsibility." - Uncle Ben
|
||||
> [!NOTE] "With great power comes great responsibility." - Uncle Ben
|
||||
|
||||
As a moderator, temperament is more important than technical skill.
|
||||
|
||||
@ -109,9 +108,7 @@ Thank you and happy coding.
|
||||
2. **Bug or Clarification issues** Try to reproduce the bug yourself if you can. If not, ask them for the steps to reproduce the bug, and whether they have any screenshots, videos, or additional details that can help you reproduce the issue. Once you can reproduce the issue - or at least confirm it's a legit issue - label it `confirmed`. Then:
|
||||
|
||||
- If it's a simple change to an existing challenge, label it as `first timers only`, otherwise label it as `help wanted`. Use other labels as appropriate.
|
||||
- If the issue is more significant, flag it as `bug`.
|
||||
|
||||
If there is any ambiguity as to the proper course of action on an issue, feel free to tag @raisedadead on the issue get his opinion on it, then add the `Discussing` label.
|
||||
- If the issue is more significant, flag it as `bug`. If there is any ambiguity as to the proper course of action on an issue, feel free to tag @raisedadead on the issue get his opinion on it, then add the `Discussing` label.
|
||||
|
||||
3. **Duplicate Issues** If an issue is the same as another reported issue, the prior reported issue should take precedence. Flag as `Duplicate`, paste the following message replacing `#XXXXX` with the issue number, then close the issue.
|
||||
|
||||
@ -169,7 +166,7 @@ Forum moderators have the ability to delete user's posts. You should only do thi
|
||||
|
||||
### Dealing with spam
|
||||
|
||||
For the first spam post of a user, 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 follow the process above. Quietly block the user from posting (using the silence option on the User Admin panel), then send a warning with the Code of Conduct. Check the box in the private message indicating that your message is a "formal warning."
|
||||
For the first spam post of a user, 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."
|
||||
|
||||
You can ask questions and report incidents in the in the [staff forum section](https://forum.freecodecamp.com/c/staff).
|
||||
|
||||
@ -203,53 +200,42 @@ Sometimes people will post things that they think are funny. They don't realize
|
||||
|
||||
But if it is an egregious offense that can't reasonably be attributed to a cultural difference or a misunderstanding of the English language, then you should strongly consider blocking the member from the Facebook group.
|
||||
|
||||
## Moderating Discord
|
||||
## Moderating Chat
|
||||
|
||||
Here's how moderators deal with violations of our [Code of Conduct](https://code-of-conduct.freecodecamp.org/) on Discord:
|
||||
Here's how moderators deal with violations of our [Code of Conduct](https://code-of-conduct.freecodecamp.org/) on our chat server:
|
||||
|
||||
1. **Make sure it was intended to violate the Code of Conduct.**
|
||||
Not all violations of the CoC were intended as such. A new camper might post a large amount of code for help, unaware that this can be considered spamming. In these cases, you can just ask them to paste their code with services like Codepen or Pastebin.
|
||||
1. **Make sure it was intended to violate the Code of Conduct.** Not all violations of the CoC were intended as such. A new camper might post a large amount of code for help, unaware that this can be considered spamming. In these cases, you can just ask them to paste their code with services like Codepen or Pastebin.
|
||||
|
||||
2. **If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:**
|
||||
|
||||
- Ban the offending person from the Discord Server. In order to ban someone, right-click on their username/profile picture and select "Ban username". You will be given the option to delete their previous messages - select "Don't delete any", as the messages should remain present as a historic record.
|
||||
- Report a short summary of the event in the #mod-log channel. Here's an example of what such a summary might look like:
|
||||
2. **If the camper clearly and intentionally violates the Code of Conduct, the moderator will proceed as follows:** Kick or mute the offending person from the chat room. In order to kick or mute someone, left-click on their profile picture, select the three dots, and select "Remove from room" to kick or "Mute user" to prevent them from sending messages. Then report a short summary of the event in the #mod-log channel. Here's an example of what such a summary might look like:
|
||||
|
||||
```
|
||||
Banned: _@username_
|
||||
Kicked: _@username_
|
||||
Reason(s): _Spamming, trolling_
|
||||
Evidence: _One or more links to the offending message(s)_
|
||||
```
|
||||
|
||||
- If you decide to ban someone, it means they're unwilling to abide to our Code of Conduct. Therefore unbanning a Camper should rarely occur. However, if the need arises, you can do so by clicking on the server name, choosing "Server Settings", choosing "Bans", selecting the user you wish to unban, and clicking "Revoke Ban".
|
||||
3. **Creating a Private Discussion** There may be situations where you need to address a concern with a camper privately. This should not be done through DMs, as this can lead to situations where you claim one thing and the camper claims another. Instead, use the bot's functionality to create a private discussion:
|
||||
|
||||
Discord Bans are global - you cannot ban a user from a specific channel, only from the entire server.
|
||||
- Call the `!fCC private username` command, where `username` is the camper's chat user name.
|
||||
- The bot will create a new channel, and add the mentioned camper and all moderators with the `Your Friendly Moderator` role. 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, call the `!fCC close` command _in the private channel_ to have the bot close and delete that channel.
|
||||
|
||||
3. **Creating a Private Discussion**
|
||||
|
||||
There may be situations where you need to address a concern with a camper privately. This should not be done through DMs, as this can lead to situations where you claim one thing and the camper claims another. Instead, use the bot's functionality to create a private discussion:
|
||||
|
||||
- Call the `!fCC moderate private @username` command, where `@username` is the _Discord mention_ of the user. If you are calling this command from a private channel (such as #mod-chat), you will need to parse the mention manually: Ensure you have Developer Mode turned on in your Discord settings, then right-click on the user's avatar and select `Copy ID`. Replace the `@username` parameter with `<@!ID>`, where `ID` is the value you copied earlier. The result should look like: `!fCC moderate private <@!465650873650118659>`.
|
||||
- The bot will create a new channel under the `private` category and add the `@username`-mentioned camper and all moderators with the `Your Friendly Moderator` role. 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, call the `!fCC moderate close` command _in the private channel_ to have the bot close and delete that channel.
|
||||
|
||||
4. **Deleting messages**
|
||||
Moderators have the ability to delete messages on Discord. They should only exercise this ability in four very specific situations:
|
||||
4. **Deleting messages** Moderators can delete messages on our chat server. They should only exercise this ability in four very specific situations:
|
||||
|
||||
- Someone has posted a pornographic or graphically violent image.
|
||||
- Someone has posted a link or code that is malicious in nature and could harm other campers who click on it.
|
||||
- Someone has flooded the chat with lots of spam messages to such an extreme extent (usually involving bots) as to render chat completely unusable.
|
||||
- Someone has posted an advertisement and/or a self-promoting message/image (social media).
|
||||
|
||||
In all other situations - even situations where the code of conduct is violated - Moderators should not delete the message as these are an important historic record. When you do delete a message, make sure you take a screenshot of it first! The screenshot can be logged in the #mod-log channel, but for the #activity-log it is sufficient to say the evidence was "removed due to sensitive content". Note: If the message contains material that would be illegal to take a screenshot of, copy the message link instead - provide that message link to @raisedadead to forward to Discord's Trust and Safety team.
|
||||
In all other situations - even situations where the code of conduct is violated - moderators should not delete the messages as they are important historic records. When you do delete a message, make sure you take a screenshot of it first! The screenshot can be logged in the #mod-log channel.
|
||||
|
||||
5. **Don’t use @everyone or @here**
|
||||
Don’t use @everyone or @here under any circumstances! Every single person in that chat room will get a notification. In some cases, tens of thousands of people.
|
||||
Instead, if you want people to see an announcement, you can pin it to the channel to allow everyone to read it.
|
||||
> [!NOTE] If the message contains material that would be illegal to take a screenshot of, copy the message link instead - provide that message link to @raisedadead to forward to Discord's Trust and Safety team.
|
||||
|
||||
6. **Don’t threaten to ban** If a camper is breaking the code of conduct, don’t threaten to ban them, and never warn them in public. Instead, talk to them privately using the bot's `private` command. No one else in that channel needs to know that you banned/suspended the person - campers can view the summary in the #activity-log channel if they want to keep up on that information. If a violation was clearly unintended and doesn't warrant a suspension or private conversation, make the offending camper aware of his / her actions without making it come across as a warning. For example:
|
||||
5. **Don’t use @all or @here** Don’t use @all or @here under any circumstances! Every single person in that chat room will get a notification. In some cases, tens of thousands of people. Instead, if you want people to see an announcement, you can pin it to the channel to allow everyone to read it.
|
||||
|
||||
- Camper posts a wall of code to request help
|
||||
6. **Don’t threaten to take action** If a camper is breaking 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 `private` command. No one else in that channel needs to know that you banned/suspended the person. If a violation was clearly unintended and doesn't warrant a suspension or private conversation, make the offending camper aware of his / her 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.
|
||||
|
||||
@ -257,34 +243,17 @@ In all other situations - even situations where the code of conduct is violated
|
||||
|
||||
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
|
||||
- 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/
|
||||
|
||||
7. **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.
|
||||
7. **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.
|
||||
|
||||
8. **Don’t contradict other moderators**
|
||||
If you disagree with the action of a moderator, talk with them in private or bring it up in the #mod-chat channel. Never override a ban, and never contradict the other moderator(s) publicly. Instead, have a cool-headed discussion in mod-chat and convince the moderator that they themselves should reverse their ban or change their point of view.
|
||||
Remember: we’re all on the same team. We want to dignify the role of moderators and present a unified front.
|
||||
8. **Don’t contradict other moderators** If you disagree with the action of a moderator, 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-chat and convince the moderator that they themselves should reverse their ban or change their point of view. Remember: we’re all on the same team. We want to dignify the role of moderators and present a unified front.
|
||||
|
||||
9. **Talk with other moderators**
|
||||
We have a room for moderators only. Use it! If you feel uncomfortable with how to handle 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 the input of every team member! Even if you totally disagree with anything in these guidelines or the Code of Conduct!
|
||||
9. **Talk with other moderators** We have a room for moderators only. Use it! If you feel uncomfortable with how to handle 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 the input of every team member! Even if you totally disagree with anything in these guidelines or the Code of Conduct!
|
||||
|
||||
10. **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-chat channel. This is so we know if we can count on you to be regularly active on the server or not.
|
||||
|
||||
## Moderating our Chat Server
|
||||
|
||||
Moderating the chat server is very similar to moderating the Discord server, but there are a few key differences:
|
||||
|
||||
1. **No Ban functionality**
|
||||
At this time, Rocket.Chat does not have a flow for banning users. Users can be muted (so they are prevented from chatting in a room) or kicked from a room.
|
||||
2. **Modified Bot Commands**
|
||||
The moderation bot in the chat server was developed with a smoother UX in mind. Some of the commands have been modified. Use the `!fCC modHelp` command to view the available functionality. Bot commands in the chat server do NOT require a user mention as they do with Discord.
|
||||
3. **No Role Mentions**
|
||||
Unlike Discord, Rocket.Chat does not allow you to mention all users by a specific role - this means you cannot ping all moderators at once.
|
||||
10. **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-chat channel. 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
|
||||
|
||||
@ -316,16 +285,12 @@ You may be approached by organizations who want to partner or co-brand with free
|
||||
|
||||
You may come across situations where users are seeking 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 at some point reflect back to fCC, 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 other than pointing the user in the direction of professional help!
|
||||
|
||||
If this happens on Discord: Create a private channel for the user and the mod team. This can be done with the bot's `private` command.
|
||||
If this happens on our chat server: Create a private channel for the user and the mod 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 be uncomfortable dealing with the situation yourself
|
||||
|
||||
If you believe the user is capable of rejoining the community, right-click on the private channel and copy the ID. Put the following message in #mod-log:
|
||||
|
||||
> Reference medical advice: `<channel ID> <username>`
|
||||
|
||||
Helpful URLs:
|
||||
|
||||
http://www.suicide.org/international-suicide-hotlines.html
|
||||
@ -397,7 +362,7 @@ git remote add upstream git://github.com/freeCodeCamp/freeCodeCamp.git
|
||||
git fetch upstream
|
||||
|
||||
git pull upstream master
|
||||
```
|
||||
````
|
||||
|
||||
If you're using a GUI, you can simply `Add a new remote...` and use the link `git://github.com/freeCodeCamp/freeCodeCamp.git` from above.
|
||||
|
||||
@ -424,7 +389,7 @@ Once you resolve these conflicts, We will be able to review your PR and merge it
|
||||
If you're not familiar with the merge conflict process, feel free to look over GitHub's guide on ["Resolving a merge conflict"](https://help.github.com/articles/resolving-a-merge-conflict-on-github/). 🔍️
|
||||
|
||||
Also, it's good practice on GitHub to write a brief description of your changes when creating a PR. 📝
|
||||
```
|
||||
````
|
||||
|
||||
¹ If a first-time-contributor has a merge conflict, maintainers will resolve the conflict for them.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user