From 9bde22f08a70266b09ec8850b8a959252a18f012 Mon Sep 17 00:00:00 2001 From: Chinar Amrutkar Date: Mon, 2 Mar 2026 13:20:52 +0000 Subject: [PATCH 1/2] fix: change branch/name-here to branch-name-here in git push commands Closes #1202 - Improves clarity for new contributors by using hyphen instead of slash in branch name placeholder. --- src/content/docs/how-to-contribute-to-the-codebase.mdx | 2 +- .../docs/how-to-setup-freecodecamp-mobile-app-locally.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/how-to-contribute-to-the-codebase.mdx b/src/content/docs/how-to-contribute-to-the-codebase.mdx index bad50f9e..8d081596 100644 --- a/src/content/docs/how-to-contribute-to-the-codebase.mdx +++ b/src/content/docs/how-to-contribute-to-the-codebase.mdx @@ -218,7 +218,7 @@ Follow these steps: 10. Next, you can push your changes to your fork: ```bash - git push origin branch/name-here + git push origin branch-name-here ``` diff --git a/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx b/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx index 66bde0ca..556b6f8e 100644 --- a/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx +++ b/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx @@ -388,7 +388,7 @@ Follow these steps: 10. Next, you can push your changes to your fork: ```bash - git push origin branch/name-here + git push origin branch-name-here ``` From 150fade44fad3da3548265a300c14976ecc4b4ff Mon Sep 17 00:00:00 2001 From: Chinar Amrutkar Date: Tue, 3 Mar 2026 22:28:37 +0000 Subject: [PATCH 2/2] docs: document create-new-project script for labs, quizzes, and reviews --- src/content/docs/how-to-contribute-to-the-codebase.mdx | 2 +- .../how-to-setup-freecodecamp-mobile-app-locally.mdx | 2 +- src/content/docs/how-to-work-on-coding-challenges.mdx | 4 ++++ src/content/docs/how-to-work-on-labs.mdx | 10 ++++++++++ src/content/docs/how-to-work-on-quizzes.mdx | 10 ++++++++++ src/content/docs/how-to-work-on-reviews.mdx | 10 ++++++++++ 6 files changed, 36 insertions(+), 2 deletions(-) diff --git a/src/content/docs/how-to-contribute-to-the-codebase.mdx b/src/content/docs/how-to-contribute-to-the-codebase.mdx index 8d081596..bad50f9e 100644 --- a/src/content/docs/how-to-contribute-to-the-codebase.mdx +++ b/src/content/docs/how-to-contribute-to-the-codebase.mdx @@ -218,7 +218,7 @@ Follow these steps: 10. Next, you can push your changes to your fork: ```bash - git push origin branch-name-here + git push origin branch/name-here ``` diff --git a/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx b/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx index 556b6f8e..66bde0ca 100644 --- a/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx +++ b/src/content/docs/how-to-setup-freecodecamp-mobile-app-locally.mdx @@ -388,7 +388,7 @@ Follow these steps: 10. Next, you can push your changes to your fork: ```bash - git push origin branch-name-here + git push origin branch/name-here ``` diff --git a/src/content/docs/how-to-work-on-coding-challenges.mdx b/src/content/docs/how-to-work-on-coding-challenges.mdx index a49287bb..394b28c4 100644 --- a/src/content/docs/how-to-work-on-coding-challenges.mdx +++ b/src/content/docs/how-to-work-on-coding-challenges.mdx @@ -741,6 +741,10 @@ If you are working with the step-based challenges, refer to the [Work on Worksho There are a few helper scripts that can be used to manage the challenges in a block. Note that these commands should all be run in the block directory. For example: +### Create a New Project + +Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`. + ```bash cd curriculum/challenges/english/blocks/basic-algorithm-scripting ``` diff --git a/src/content/docs/how-to-work-on-labs.mdx b/src/content/docs/how-to-work-on-labs.mdx index 19fbcd52..55f8f85f 100644 --- a/src/content/docs/how-to-work-on-labs.mdx +++ b/src/content/docs/how-to-work-on-labs.mdx @@ -35,3 +35,13 @@ For the labs that do not have a demo project, the solution can be the minimum ne The labs that have a demo project have a `demoType` property in the frontmatter with a value of `onClick`, the labs that do not have a demo project do not have a `demoType` project. The metadata for labs require a `blockType` property with a value of `lab`, and a `blockLayout` with a value of `link`. + +## Using the Scripts Manually + +If you want to work on the challenges manually, in your local IDE, you can run the step management scripts directly. + +The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum. + +### Create a New Project + +Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`. diff --git a/src/content/docs/how-to-work-on-quizzes.mdx b/src/content/docs/how-to-work-on-quizzes.mdx index 51134d81..ee62633e 100644 --- a/src/content/docs/how-to-work-on-quizzes.mdx +++ b/src/content/docs/how-to-work-on-quizzes.mdx @@ -165,3 +165,13 @@ Also, any question that was taken from external quiz sites is prohibited. Please come up with your own quiz questions and answers. + +## Using the Scripts Manually + +If you want to work on the challenges manually, in your local IDE, you can run the step management scripts directly. + +The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum. + +### Create a New Project + +Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`. diff --git a/src/content/docs/how-to-work-on-reviews.mdx b/src/content/docs/how-to-work-on-reviews.mdx index 88bcb0c7..eb0a59d1 100644 --- a/src/content/docs/how-to-work-on-reviews.mdx +++ b/src/content/docs/how-to-work-on-reviews.mdx @@ -31,3 +31,13 @@ The metadata for reviews require a `blockType` property with a value of `review` Reviews use a `challengeType` of 31. Reviews have a dashedName with `review-topic`, and titles of the reviews are like `Topic Review`. + +## Using the Scripts Manually + +If you want to work on the challenges manually, in your local IDE, you can run the step management scripts directly. + +The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum. + +### Create a New Project + +Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`.