Skip to content

dx: CONTRIBUTING.md references a testing command that doesn't match package.json scripts #382

Description

@Xhristin3

Problem Statement
CONTRIBUTING.md documents development workflow commands. Some may reference scripts that do not exist or have been renamed. First-time contributors following the guide encounter errors before they've made any changes.

Why It Matters
Broken contributor documentation is demoralising and signals poor project maintenance quality.

Acceptance Criteria

  • Audit every command in CONTRIBUTING.md against the actual scripts in all package.json files
  • Fix any discrepancies
  • Add a CI step that validates npm run lint, npm run test, and npm run build all succeed
  • Add a CONTRIBUTING.md badge linking to the contribution guide from the README

Files Affected: CONTRIBUTING.md, README.md

Difficulty: Easy | Effort: 1–2 hours

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26documentationImprovements or additions to documentationdxgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions