Skip to content

Fix the client size limit in the TypeScript standard (6 KB, not 5 KB) #11

Closed

Description

@MobileMage

What is wrong

standards/languages/typescript.md, line 30, gives the wrong size limit for the client package:

| size-limit | size limits | core 4 KB, client 5 KB, field 20 KB, compressed, as size-limit measures them |

The client package in the js repo sets the limit to 6 KB. See packages/client/package.json, key size-limit, field limit: "6 KB".

What to change

Change client 5 KB to client 6 KB on that line. The core limit of 4 KB already matches packages/core/package.json in the js repo. Leave the field limit alone, because the field package is not on the main branch of js yet.

How to check

make check

make check needs Python 3.11 or later and uv. To run only the unit tests, run make test.

Where to read first

  • CONTRIBUTING.md in the organisation's .github repository.
  • standards/languages/typescript.md, the table that holds line 30.

Activity

  1. lui01212 commented on Oct 3, 2026

    @lui01212
    Contributor

    Hi, I'd like to work on this. I checked the client package configuration and confirmed the limit is 6 KB. I'll update the documented client limit, leave the core and field limits as they are, and run make check before opening a PR.

  2. MobileMage commented on Oct 3, 2026

    @MobileMage
    CollaboratorAuthor

    It's yours. I assigned the issue to you.

    Your plan is right: change only client 5 KB to client 6 KB on that line, and leave the core and field limits alone.

    Three things that help the checks pass the first time:

    • The spec repo uses no commit scope, so a subject such as docs: correct the client size limit in the TypeScript standard works. Sign off the commit with git commit -s.
    • The pull request title and description become the squash commit. A check reads them, so give the title the same form as a commit subject, and end the description with your Signed-off-by: line.
    • make check needs Python 3.11 or later and uv.

    An open branch of mine (#4) edits the same line for the new field package. Don't worry about it. Yours goes in first, and I will sort out the overlap on my side.

    If anything in CONTRIBUTING.md is unclear while you work, say so here. That is useful feedback too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions