diff --git a/src/content/config.ts b/src/content/config.ts index 3dcadb90..2d49722e 100644 --- a/src/content/config.ts +++ b/src/content/config.ts @@ -13,6 +13,9 @@ export const collections = { 'sidebar.report_vulnerability': z.string(), 'sidebar.translation_contribution': z.string(), 'sidebar.translate_resources': z.string(), + 'sidebar.english_contribution': z.string(), + 'sidebar.english_resources': z.string(), + 'sidebar.english_description': z.string(), 'sidebar.proofread_translations': z.string(), 'sidebar.code_contribution': z.string(), 'sidebar.setup_freecodecamp': z.string(), diff --git a/src/content/docs/english-for-developers-intro.mdx b/src/content/docs/english-for-developers-intro.mdx new file mode 100644 index 00000000..29f8f674 --- /dev/null +++ b/src/content/docs/english-for-developers-intro.mdx @@ -0,0 +1,58 @@ +--- +title: English for Developers Curriculum Structure +--- + +import { Steps } from '@astrojs/starlight/components'; + +The **English for Developers** curriculum is designed to help non-native English speakers improve their language skills, focusing on communication in software development. This curriculum aligns with the **Common European Framework of Reference for Languages (CEFR)** and provides structured lessons for learners at different proficiency levels. + +## Curriculum Levels + +The curriculum is structured into multiple levels, each targeting specific language skills essential for developers: + +- **CEFR Level A2** – A pre-intermediate level focusing on foundational English skills. It introduces essential vocabulary, phrases, and real-world scenarios that developers encounter in their daily work. +- **CEFR Level B1** – An intermediate level that builds on the basics. It emphasizes professional communication, reading technical documentation, and participating in workplace discussions. + +Future levels, including **B2 and C1**, will further enhance learners’ proficiency in advanced technical and professional communication. + +## How the Curriculum is Structured + +The beta version of the **English for Developers** curriculum is structured around contextual modules, each built on a series of dialogues. Campers begin by listening or reading the full dialogue they will study. Then, step by step, tasks guide them through each line, introducing relevant vocabulary, grammatical structures, and practical usage in a developer’s context. + +This documentation outlines the framework used to create these tasks, ensuring that contributors can review the curriculum while maintaining consistency with standard guidelines. + +## Help Improve This Curriculum + +If you've found something that needs to be fixed, there are several ways you can contribute: + +- Report a bug. +- Submit a pull request (PR) with fixes. +- Request a feature. +- Work on "help wanted" issues. + +### Reporting a Bug + +If you think you've found a bug, start by reading our [How to Report a Bug](https://www.freecodecamp.org/news/how-to-report-a-bug-to-freecodecamp/) guide and follow the steps outlined there. + +If you're certain it's a new bug, create a GitHub issue with as much detail as possible. We provide an issue template to help you structure your report effectively. + +:::note +GitHub issues are for reporting code-related problems, **not** for requesting help with learning or solving curriculum tasks. If you're unsure, [ask for help in the forum](https://forum.freecodecamp.org) before opening an issue. +::: + +### Creating a Pull Request (PR) to Fix Bugs + +Before working on a fix, you'll need to set up your development environment. Follow the step-by-step instructions in the [How to Set Up freeCodeCamp Locally](https://contribute.freecodecamp.org/how-to-setup-freecodecamp-locally/) guide. + +Once your environment is ready, you can make the necessary changes and submit a pull request (PR) for approval. + +You can submit PRs to: + +- Fix reported bugs. +- Fix bugs you might have found. +- Solve issues tagged as "help wanted". +- Correct tasks that do not follow the English for Developers formatting guidelines. + +:::tip +To learn more about the formatting guidelines, check the related pages in the sidebar. +::: diff --git a/src/content/docs/english-tasks-description.mdx b/src/content/docs/english-tasks-description.mdx new file mode 100644 index 00000000..60d83736 --- /dev/null +++ b/src/content/docs/english-tasks-description.mdx @@ -0,0 +1,7 @@ +--- +title: English tasks descriptions +--- + +import { Steps } from '@astrojs/starlight/components'; + +; diff --git a/src/content/docs/intro.mdx b/src/content/docs/intro.mdx index d11a3c84..2bfb2354 100644 --- a/src/content/docs/intro.mdx +++ b/src/content/docs/intro.mdx @@ -41,4 +41,8 @@ import { Card, CardGrid } from '@astrojs/starlight/components'; [Contribute with code](/getting-started/#learning-platform) to our open-source codebases. + + [Help to review](/english-for-developers-intro/) English for Developers + Curriculum. + diff --git a/src/content/i18n/en.json b/src/content/i18n/en.json index c49a1fd1..071b8110 100644 --- a/src/content/i18n/en.json +++ b/src/content/i18n/en.json @@ -43,6 +43,9 @@ "sidebar.report_vulnerability": "Reporting a Vulnerability", "sidebar.translation_contribution": "Translation Contribution", "sidebar.translate_resources": "Work on translating resources", + "sidebar.english_contribution": "English for Developers", + "sidebar.english_resources": "English tasks structure", + "sidebar.english_description": "English tasks descriptions", "sidebar.proofread_translations": "Work on proofreading translations", "sidebar.code_contribution": "Code Contribution", "sidebar.setup_freecodecamp": "Set up freeCodeCamp", diff --git a/src/update-pagination.ts b/src/update-pagination.ts index 93ca4fdf..85bb8990 100644 --- a/src/update-pagination.ts +++ b/src/update-pagination.ts @@ -38,6 +38,19 @@ export const content: Section[] = [ } ] }, + { + title: 'sidebar.english_contribution', + contents: [ + { + href: '/english-for-developers-intro/', + title: 'sidebar.english_resources' + }, + { + href: '/english-tasks-description/', + title: 'sidebar.english_description' + } + ] + }, { title: 'sidebar.code_contribution', contents: [