diff --git a/README.md b/README.md index 5ac8968c4..2eaffbddd 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,13 @@ The p5.js Editor is a collaborative project created by many individuals, mostly 3. [All Contributors list on the p5.js repository](https://github.com/processing/p5.js?tab=readme-ov-file#contributors) - Explore the All Contributors list to see the wide range of contributions by our amazing community! +> **TypeScript Migration:** +> As of July 2025, we are working on migrating the repo to TypeScript as part of the **[p5.js Web Editor pr05 Grant](https://github.com/processing/pr05-grant/wiki/2025-pr05-Program-Page)**. +> This migration will occur in two phases: +> 1. **Grant Work (July – October 31, 2025)** – Setting up TypeScript configuration, tooling, and starting partial migration. Contributions will be **closed** during this period. +> 2. **Open Contribution (After October 31, 2025)** – TypeScript migration tasks will **open** to all contributors, with guidelines and tutorials available. +> +> For full details, see [TypeScript Migration Plan](./contributor_docs/typescript-migration.md). ## Acknowledgements 🙏 diff --git a/contributor_docs/README.md b/contributor_docs/README.md index 6df414766..01aa63170 100644 --- a/contributor_docs/README.md +++ b/contributor_docs/README.md @@ -15,6 +15,7 @@ These guides aren't exhaustive, and do not cover all the possible ways you can c * [Translations Guidelines](translations.md) - Guidelines for translating the p5.js editor. * [Deployment](deployment.md) - A guide to production deployment, and all platforms that are being used. * [Release](./release.md) - A guide to creating a production release. +* [Typescript Migration](./typescript_migration.md) - About the Typescript Migration project. ## Documents to Create diff --git a/contributor_docs/typescript_migration.md b/contributor_docs/typescript_migration.md new file mode 100644 index 000000000..e1d481871 --- /dev/null +++ b/contributor_docs/typescript_migration.md @@ -0,0 +1,22 @@ +# TypeScript Migration + +This repository is undergoing a TypeScript migration as part of the **2025 pr05 Grant: Incremental Typescript Migration of the p5.js Web Editor**, running **July – October 31, 2025**. Details on the [pr05 grant](https://github.com/processing/pr05-grant/wiki/2025-pr05-Program-Page) and [migration project](https://github.com/processing/pr05-grant/wiki/2025-pr05-Project-List#incremental-typescript-migration-for-the-p5js-editor). + +## Phase 1: Grant Work (July – October 31, 2025) + +During this period, the grant team will: + +- Configure and enable TypeScript across the project (`tsconfig`, linting, type checking, etc). +- Set up linting, testing, and other related developer tooling for TS. +- Begin migrating selected JavaScript files to TypeScript. +- Prepare documentation and workflow so migration tasks can become **good first issues** for new contributors. + +> **Note:** While this initial setup and partial migration is in progress, contributions to the migration itself will **not** be open to the public. + +## Phase 2: Open Contribution (After October 31, 2025) + +When the grant period ends: + +- The migration effort will open up to all contributors. +- This section will include **guidelines, tutorials, and examples** for migrating files from JavaScript to TypeScript in this project. +- Migration tasks will be clearly labeled in the issue tracker (e.g., `good first issue`, `typescript migration`). \ No newline at end of file