Skip to content

Improve CONTRIBUTING.md clarity and add example for new demo contributions #877

@DivaQueen-dev

Description

@DivaQueen-dev

The current CONTRIBUTING.md is detailed and friendly, but there are a few areas where contributors—especially first-timers—might benefit from extra guidance:

Suggestions

  1. Add a concrete example of adding a new demo

    • Show how to add a demo, including folder structure, HTML/CSS file naming, and README entry.
  2. Clarify the README update process

    • Contributors might be unsure how to integrate their demo into the main README and style guide.
  3. Add a checklist for first-time contributors

    • Fork → Branch → Add Demo → Test → Update README → Commit → Push → PR
    • Helps make the process less intimidating.
  4. Optional: Visual examples

    • Include screenshots or GIFs showing a completed demo entry in the README.

Enhancing CONTRIBUTING.md in these ways would make it easier for new contributors to jump in confidently and improve project engagement.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions