Problem
Two npm packages have READMEs that describe an entirely different tool (PNLΓçäXML converter) instead of their actual functionality:
Affected Repos
| Repository |
README describes |
Actual purpose |
npm-winccoa-log-reader |
PNLΓçäXML converter for UI panels |
Log reader (based on repo name) |
npm-winccoa-test-runner |
PNLΓçäXML converter ("THIS IS AN EXAMPLE README") |
Test runner (based on repo name) |
Root Cause
Both repos appear to have been scaffolded from template-npm-shared-library, which uses a PNLΓçäXML converter as its example content. The template README was never replaced with project-specific documentation.
Additional Issues
package.json description in both repos is still "Template for WinCC OA npm packages"
- Source code in both repos also appears to be template converter code, not log-reader/test-runner code
npm-winccoa-test-runner README explicitly contains "THIS IS AN EXAMPLE README"
Required Actions
- Decide: Do these repos contain real functionality, or are they empty scaffolds?
- If real projects: Rewrite READMEs and
package.json descriptions to match actual purpose
- If empty scaffolds: Consider archiving or clearly marking as WIP
- Update
package.json "description" field in both repos
Impact
Users/contributors visiting these repos get completely wrong information about what the package does.
Sub-issues
Problem
Two npm packages have READMEs that describe an entirely different tool (PNLΓçäXML converter) instead of their actual functionality:
Affected Repos
npm-winccoa-log-readernpm-winccoa-test-runnerRoot Cause
Both repos appear to have been scaffolded from
template-npm-shared-library, which uses a PNLΓçäXML converter as its example content. The template README was never replaced with project-specific documentation.Additional Issues
package.jsondescription in both repos is still"Template for WinCC OA npm packages"npm-winccoa-test-runnerREADME explicitly contains "THIS IS AN EXAMPLE README"Required Actions
package.jsondescriptions to match actual purposepackage.json"description"field in both reposImpact
Users/contributors visiting these repos get completely wrong information about what the package does.
Sub-issues