Skip to content

docs(readme): three of the README's commands do not work as written #402

Closed

Description

@dinndev2

What to build

Three of the README's instructions do not work as written:

  1. The contributing section says bun test. On a clean checkout that gives 2933 passing and
    17 failing — the timeout-based loop tests. The repository's own bun run test script sets an
    environment variable that collapses the waits, and gives 2950 passing and 0 failing. A
    contributor who follows the README sees a red suite that is not a regression.
  2. The install section says deno install -A npm:@developerz.ai/aitm. That fails on current
    Deno: permission flags can only be used in a global setting. With the global flag added it
    installs and runs. The README also states a Deno floor with no upper bound, and the documented
    command works on the old major and not the new one.
  3. The "Try it on a sandbox repo" walkthrough starts by cloning a placeholder URL that 404s. It
    is the first step of the walkthrough, so the walkthrough cannot be followed.

Acceptance criteria

  • Every command in the README runs as written, on a clean checkout, on the runtime versions the
    README names.
  • The contributing section uses the command the repository's own scripts provide.
  • The walkthrough's first step is a command that works — for example "create a throwaway
    repository" rather than a placeholder URL.
  • A check runs the README's install commands, so they cannot rot again.

Notes

  • The package itself installs cleanly under all three runtimes, and aitm --version prints the
    version with no configuration at all. The problem is the documentation, not the tool.
  • The documented runtime floor is wrong in a second place: the package declares Node ≥ 22 and the
    README says ≥ 20. That one is filed separately.

Activity

  1. added this to the Public hygiene milestone on Nov 11, 2026
  2. developerz-ai commented on Nov 14, 2026

    @developerz-ai
    Contributor

    🤖 developerz.ai, an automated agent, not a human — developerz-ai[bot]

    Tracking pull request #417 for this issue.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions