-
Notifications
You must be signed in to change notification settings - Fork 80
Description
Describe the bug
The docs/CONTRIBUTING.md file instructs contributors to manually edit scripts/contributors.js and add their filename to the contributorFiles array. However, scripts/contributors.js is auto-generated by scripts/generate-cards.sh, which is already run automatically in both CI workflows (deploy.yml and pr-preview.yml). Contributors only need to add their .html file to the contributors/ directory — the CI pipeline handles the rest.
To Reproduce
- Open
docs/CONTRIBUTING.md - Go to the "Add your card to contributors list" section (lines 81–91)
- See that it instructs users to manually edit
scripts/contributors.js - Check
.github/workflows/deploy.ymland.github/workflows/pr-preview.yml— both already runbash scripts/generate-cards.shautomatically
Expected behavior
The "Add your card to contributors list" section should be removed or replaced, since the CI pipeline automatically generates contributors.js from the files in the contributors/ directory. No manual step is needed beyond creating the .html file.
Screenshots
N/A
Desktop (please complete the following information):
N/A — this is a documentation issue, not platform-specific.
Smartphone (please complete the following information):
N/A