gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

general educational fixes in some files (#40800)

Browse Source 
Co-authored-by: Ilenia <nethleen@gmail.com>
Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com>
Co-authored-by: nhcarrigan <nhcarrigan@gmail.com>
This commit is contained in:
Talla Giridhar
2021-02-03 15:17:56 +05:30
committed by GitHub
parent 7ef29e62a8
commit c1f9cd93f5
11 changed files with 79 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/how-to-work-on-coding-challenges.md
View File

@ -12,9 +12,9 @@ Creating these challenges requires immense creativity and attention to detail. T
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/contributors).
With your help we can design an interactive coding curriculum that will help millions of people learn to code for years to come.
With your help, we can design an interactive coding curriculum that will help millions of people learn to code for years to come.
The content for each challenge is stored in its own markdown file. This markdown file is later converted to HTML using our tools to create interactive web pages.
The content for each challenge is stored in its markdown file. This markdown file is later converted to HTML using our tools to create interactive web pages.
You can find all of freeCodeCamp.org's curricular content in the [`/curriculum/challenges`](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/curriculum/challenges) directory.
@ -57,7 +57,7 @@ Challenge instruction text, in markdown
# --hints--
Tests to run against user code, in pairs of markdown text and codeblock test code.
Tests to run against user code, in pairs of markdown text and code block test code.
```js
Code for test one
@ -132,7 +132,7 @@ Solutions are used for the CI tests to ensure that changes to the hints will sti
# --question--
These fields are currently used for the multiple choice Python challenges.
These fields are currently used for the multiple-choice Python challenges.
## --text--
@ -207,7 +207,7 @@ All challenge titles should be explicit and should follow this pattern:
Here are some example challenge names:
- Use Clockwise Notation to Specify the Padding of an Element
- Condense arrays with .reduce
- Condense arrays with .reduce
- Use Bracket Notation to Find the First Character in a String
## Challenge descriptions/instructions
@ -220,7 +220,7 @@ Challenge text should use the second person ("you") to help to give it a convers
Don't use outbound links. These interrupt the flow. Campers should never have to google anything during these challenges. If there are resources you think campers would benefit from, add them to the challenge's Guide-related article.
You can add diagrams if absolutely necessary.
You can add diagrams if necessary.
Don't use emojis or emoticons in challenges. freeCodeCamp has a global community, and the cultural meaning of an emoji or emoticon may be different around the world. Also, emojis can render differently on different systems.
@ -232,7 +232,7 @@ Proper nouns should use correct capitalization when possible. Below is a list of
### The 2-minute rule
Each challenge should be solvable within 120 seconds by a native English speaker who has completed the challenges leading up to it. This includes the amount of time it takes to read the directions/instructions understand the seeded code, write their own code and get all the tests to pass.
Each challenge should be solvable within 120 seconds by a native English speaker who has completed the challenges leading up to it. This includes the amount of time it takes to read the directions/instructions understand the seeded code, write their code and get all the tests to pass.
If it takes longer than two minutes to complete the challenge, you have two options:
@ -256,13 +256,13 @@ 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:
- 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.
- 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 newline 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.
- 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.
**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.
@ -302,7 +302,7 @@ Here are specific formatting guidelines for the challenge seed code:
We have a [comment dictionary](/curriculum/dictionaries/english/comments.js) that contains the only comments that can be used within the seed code. The exact case and spacing of the dictionary comment must be used. The comment dictionary should not be expanded without prior discussion with the dev-team.
Comments used should have a space between the comment characters and the comment themselves. In general comments should be used sparingly. Always consider rewriting a challenge's description or instructions if it could avoid using a seed code comment.
Comments used should have a space between the comment characters and the comment themselves. In general, comments should be used sparingly. Always consider rewriting a challenge's description or instructions if it could avoid using a seed code comment.
Example of valid single line JavaScript comment:
@ -362,9 +362,9 @@ class MyComponent extends React.Component {
### Translation of seed code comments
There are separate comment dictionaries for each language. The [English vesion 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.
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
@ -372,7 +372,7 @@ Declare the myGlobal variable below this line
>[!NOTE]
>
> We are working on an integration to make it possible to work on i18n for the comment dictionary.
> We are working on an integration to make it possible to work on i18n for the comment dictionary.
## Hints and Solutions
@ -400,7 +400,7 @@ When proposing a solution for a curriculum challenge related Guide topic, the fu
## Problem Explanation
This summarizes what need to be done without just restating the challenge description and/or instructions. This is an optional section
This summarizes what needs to be done without just restating the challenge description and/or instructions. This is an optional section
#### Relevant Links