Skip to content

The documentation in the doc/CONTRIBUTING.md is misleading #62

Description

@josephkabba

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

  1. Open docs/CONTRIBUTING.md
  2. Go to the "Add your card to contributors list" section (lines 81–91)
  3. See that it instructs users to manually edit scripts/contributors.js
  4. Check .github/workflows/deploy.yml and .github/workflows/pr-preview.yml — both already run bash scripts/generate-cards.sh automatically

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingquestionFurther information is requested

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions