Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md references npm scripts that don't exist #2815

Closed
shawninder opened this issue Dec 20, 2024 · 1 comment
Closed

CONTRIBUTING.md references npm scripts that don't exist #2815

shawninder opened this issue Dec 20, 2024 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@shawninder
Copy link

Search terms

test:visual, test:visual:accept, CONTRIBUTING.md

Expected Behavior

I should be able to follow the directions in CONTRIBUTING.md and successfully run the commands it mentions.

Actual Behavior

CONTRIBUTING.md mentions npm scripts that don't exist on the repo: test:visual and test:visual:accept. These are mentioned in 2 places:

  • Under #### Installation, step 8
  • Under #### Testing, near the end of paragraph 1

Steps to reproduce the bug

  • Follow instructions from CONTRIBUTING.md:
    • fork repo
    • clone fork
    • install dependencies
    • build
    • Set up a baseline for visual theme testing <-- THIS IS THE PROBLEMATIC STEP
      • EXPECT npm run test:visual to launch a test suite
      • OBSERVER npm erroring out saying npm error Missing script: "test:visual"
      • EXPECT npm run test:visual:accept to launch a test suite which accepts the produced visual artifacts
      • OBSERVER npm erroring out saying npm error Missing script: "test:visual:accept"

Environment

  • Typedoc version: 0.27.5
  • TypeScript version: 5.7.2
  • Node.js version: 22.12.0
  • OS: macOS Monterey 12.7.6
@shawninder shawninder added the bug Functionality does not match expectation label Dec 20, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 20, 2024

Thanks, updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants