MetaCell / MetaCell/geppetto-meta

Add optional parameter to read different React Element name for snippet

Open
#2 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement geppetto-meta-website geppetto-showcase good first issue
Dominant language
JavaScript
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Currently the conversion of the README.md of a component to a rendered showcase entry in the geppetto-showcase has a rule that states that the filename of the ComponentToShowcase and the component name itself should be the same. (f.e. ConnectivityComponent should be written in a file named ConnectivityComponent.js)

We should have an optional parameter to allow different names between components and filenames.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the rule that converts a component README.md into a rendered geppetto-showcase entry and enforces matching filenames and component names. Trace how the ComponentToShowcase name is read, then define the optional naming parameter and verify that entries with different names are handled while existing matching names still work.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.