docs: suggest adding compatibility date migration guide to README

Open Beginner friendly
#7,282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start in the README section that describes compatibility_date and review how workerd configuration is currently explained. Add a concise migration guide covering how to check the current date, possible breaking changes, and local testing of a newer date; done means all three points are clear to new Workers users.

Written by the indexing model from the issue text.

Description

建议

当前 README 中提到了 compatibility_date 配置，但缺少从旧日期迁移到新日期的详细指南。建议添加一个简短的迁移说明，包括：

  1. 如何检查当前使用的 compatibility_date
  2. 升级 compatibility_date 时需要注意的破坏性变更
  3. 如何在本地测试新的 compatibility_date

这对新用户理解 Workers 运行时的版本管理会很有帮助。

背景

在使用 workerd 进行本地开发时，compatibility_date 的选择会影响可用的 API。新用户可能不清楚如何选择合适的日期。

Dominant language
C++
Stars
8.8k
Forks
744
Avg merge
2d 12h
Merged PRs (30d)
205

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloudflare/workerd

All issues in cloudflare/workerd

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.