Skip to content

Commit 583c070

Browse files
committed
add docs on migration
1 parent 40b1b0b commit 583c070

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ The p5.js Editor is a collaborative project created by many individuals, mostly
2626

2727
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!
2828

29+
> **TypeScript Migration:**
30+
> 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)**.
31+
> This migration will occur in two phases:
32+
> 1. **Grant Work (July – October 31, 2025)** – Setting up TypeScript configuration, tooling, and starting partial migration. Contributions will be **closed** during this period.
33+
> 2. **Open Contribution (After October 31, 2025)** – TypeScript migration tasks will **open** to all contributors, with guidelines and tutorials available.
34+
>
35+
> For full details, see [TypeScript Migration Plan](./contributor_docs/typescript-migration.md).
2936
3037
## Acknowledgements 🙏
3138

contributor_docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ These guides aren't exhaustive, and do not cover all the possible ways you can c
1515
* [Translations Guidelines](translations.md) - Guidelines for translating the p5.js editor.
1616
* [Deployment](deployment.md) - A guide to production deployment, and all platforms that are being used.
1717
* [Release](./release.md) - A guide to creating a production release.
18+
* [Typescript Migration](./typescript_migration.md) - About the Typescript Migration project.
1819

1920

2021
## Documents to Create
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# TypeScript Migration
2+
3+
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).
4+
5+
## Phase 1: Grant Work (July – October 31, 2025)
6+
7+
During this period, the grant team will:
8+
9+
- Configure and enable TypeScript across the project (`tsconfig`, linting, type checking, etc).
10+
- Set up linting, testing, and other related developer tooling for TS.
11+
- Begin migrating selected JavaScript files to TypeScript.
12+
- Prepare documentation and workflow so migration tasks can become **good first issues** for new contributors.
13+
14+
> **Note:** While this initial setup and partial migration is in progress, contributions to the migration itself will **not** be open to the public.
15+
16+
## Phase 2: Open Contribution (After October 31, 2025)
17+
18+
When the grant period ends:
19+
20+
- The migration effort will open up to all contributors.
21+
- This section will include **guidelines, tutorials, and examples** for migrating files from JavaScript to TypeScript in this project.
22+
- Migration tasks will be clearly labeled in the issue tracker (e.g., `good first issue`, `typescript migration`).

0 commit comments

Comments
 (0)