Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

## Unreleased

This pass covers the JavaScript side only. See the note in the README about why
React Native itself stays on 0.68.
This pass covers the JavaScript side only.

### Fixed

Expand Down Expand Up @@ -50,8 +49,7 @@ React Native itself stays on 0.68.

### Added

- English `README_EN.md` alongside the Chinese `readme.md`, both with badges and
a plain statement of the React Native version situation.
- A Chinese `README_CN.md` alongside the English `README.md`, both with badges.
- `CONTRIBUTING.md` and this changelog.
- `ci.yml`: lint, type-check and test on Node 20 and 22. It deliberately does
not build the apps — that needs Xcode and the Android SDK.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ Run `pnpm format` before committing so Prettier settles the formatting; CI does

- **Commit messages** follow [Conventional Commits](https://www.conventionalcommits.org/):
`fix:`, `feat:`, `docs:`, `chore:`, `refactor:`, `test:`.
- **Both READMEs.** If a change affects how the framework is used, update `readme.md` _and_
`README_EN.md`.
- **Both READMEs.** If a change affects how the framework is used, update `README.md` _and_
`README_CN.md`.
- **Keep the type check clean.** Several real bugs in this repo were hidden by
`suppressImplicitAnyIndexErrors` and an ancient TypeScript; `pnpm tslint` must stay at 0 errors.
- **Test pure logic, not the whole app.** Rendering `<App />` needs the full native module surface
Expand Down Expand Up @@ -162,7 +162,7 @@ pnpm test # jest
## 一些约定

- **提交信息**遵循 [Conventional Commits](https://www.conventionalcommits.org/):`fix:`、`feat:`、`docs:`、`chore:`、`refactor:`、`test:`。
- **两份 README。** 如果改动影响了框架用法,请同时更新 `readme.md` 和 `README_EN.md`。
- **两份 README。** 如果改动影响了框架用法,请同时更新 `README.md` 和 `README_CN.md`。
- **保持类型检查干净。** 这个仓库里好几个真 bug 都是被 `suppressImplicitAnyIndexErrors` 和过旧的 TypeScript 盖住的,`pnpm tslint` 必须保持 0 error。
- **测纯逻辑,不要测整个 App。** 渲染 `<App />` 需要 mock 全部原生模块,在 CI 里跑不完。测试放在 `__tests__/*-test.ts`。

Expand Down
12 changes: 1 addition & 11 deletions README_EN.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,11 @@
<p align="center">
<a href="./CHANGELOG.md">Changelog</a>
·
<a href="./readme.md">中文文档</a>
<a href="./README_CN.md">中文文档</a>
</p>

---

> [!NOTE]
> **React Native is still on 0.68.**
>
> Moving to the current release (0.87) crosses the New Architecture (Fabric / TurboModules) and
> means regenerating the `ios/` and `android/` projects — work that needs Xcode and the Android SDK
> to verify, not something that can be done from the JavaScript side alone.
>
> **The JavaScript side has been brought up to date**: TypeScript 5.9 with zero type errors, ESLint
> with zero errors, and a unit test suite that runs. See [CHANGELOG.md](./CHANGELOG.md).

## Commands

```shell
Expand Down
9 changes: 1 addition & 8 deletions readme.md → README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,11 @@
<p align="center">
<a href="./CHANGELOG.md">更新日志</a>
·
<a href="./README_EN.md">English</a>
<a href="./README.md">English</a>
</p>

---

> [!NOTE]
> **React Native 仍停留在 0.68。**
>
> 升级到当前版本(0.87)要跨越新架构(Fabric / TurboModules),并重新生成 `ios/` 和 `android/` 原生工程 —— 这需要 Xcode 和 Android SDK 才能验证,不是纯 JS 侧能完成的工作。
>
> **JS 侧已经完成维护**:TypeScript 升到 5.9 并做到 0 类型错误、ESLint 0 error、单元测试可运行。详见 [CHANGELOG.md](./CHANGELOG.md)。

## 命令

```shell
Expand Down
Loading