Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor fixes to how to work on coding challenges #48644

Closed
wants to merge 2 commits into from

Conversation

jcjc2019
Copy link

@jcjc2019 jcjc2019 commented Dec 1, 2022

Checklist:

  • I have read freeCodeCamp's contribution guidelines.
  • My pull request has a descriptive title (not a vague title like Update index.md)
  • My pull request targets the main branch of freeCodeCamp.
  • I have tested these changes either locally on my machine, or GitPod.

Some minor doc updates to clarify the meanings for the docs on coding challenges, including some minor changes to clarify the video solution.

@gitpod-io
Copy link

gitpod-io bot commented Dec 1, 2022

@github-actions github-actions bot added the scope: docs Codebase and other documentation label Dec 1, 2022
@@ -251,7 +252,7 @@ We track how long it takes for campers to solve challenges and use this informat

Each challenge should teach exactly one concept, and that concept should be apparent from the challenge's name.

We can reinforce previously covered concepts through repetition and variations - for example, introducing h1 elements in one challenge, then h3 elements a few challenges later.
We can reinforce previously covered concepts through repetition and variations, for example, introducing h1 elements in one challenge, then h3 elements a few challenges later.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would split this sentence up. I don't think that putting a comma here is correct grammar. As a general rule, commas should be used sparingly. They aren't replacements for conjunctions.

We can reinforce previously covered concepts through repetition and variation. For example, we can introduce h1 elements in one challenge and h3 elements a few challenges later.

@@ -2,7 +2,7 @@

Our goal is to develop a fun and clear interactive learning experience.

Designing interactive coding challenges is difficult. It would be much easier to write a lengthy explanation or to create a video tutorial. But for our core curriculum, we're sticking with what works best for most people - a fully interactive, video game-like experience.
Designing interactive coding challenges is difficult. It would be much easier to write a lengthy explanation or to create a video tutorial. But for our core curriculum, we're sticking with what works best for most people -- a fully interactive, video game-like experience.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a style guide for this sort of thing? Using -- in a block of text is a bit unusual in my experience

@raisedadead raisedadead changed the title docs(scope: docs): minor fixes to clarify docs: minor fixes to how to work on coding challenges Dec 9, 2022
@raisedadead
Copy link
Member

We are officially on Node.js 18 now. We have changed the merge requirements accordingly.

You will need to rebase this PR against the main branch OR Click the "Update branch" button to get the new checks going.

Thanks for your contribution.

@raisedadead
Copy link
Member

Hi,

We are closing old issues/pull requests that we think are stale. If you still need help or are fixing this, please open a new issue/pull request.

Thanks for your understanding.

Happy contributing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Codebase and other documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants