iamkun/dayjsNew scan
94/ 100 · A

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

⏰ Day.js 2kB immutable date-time library alternative to Moment.js with the same modern API

JavaScript48,657 starsMITupdated 18d ago
DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
93
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    Install and run instructions
    DocumentationInfo

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility
    EngineeringInfo

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

Detailed breakdown

Documentation

93
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide75
    • Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

93
  • Tests100
    • Test files detected (test).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/check.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI includes a build step.
  • Linting and formatting75
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
  • Reproducibility70
    • Lockfile present (package-lock.json). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: JavaScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 48,657 stars.
  • Housekeeping100
    • .gitignore present.
Repository files21 root entries
  • .github
    Good: CI is configured (.github/workflows/check.yml).
    Good: Issue or PR templates present.
  • build
  • docs
  • patches
  • src
  • test
    Good: Test files detected (test).
  • types
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintrc.json
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .releaserc
  • babel.config.js
  • CHANGELOG.md
    Good: Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • CONTRIBUTING.md
  • karma.sauce.conf.js
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • prettier.config.js
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.