metricsgraphics / metricsgraphics/react-metrics-graphics

Mention adding metrics-graphics

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
69
Forks
18
PR merge metrics
No merged PRs in 30d

Description

If you just add react-metrics-graphics and try to use it as indicated in the README.md it won't work.

You will get this issue:

ERROR in ./node_modules/react-metrics-graphics/build/MetricsGraphics.js
Module not found: Error: Can't resolve 'metrics-graphics/dist/metricsgraphics.css' in '/Users/armenzg/repos/js-perf-dashboard/node_modules/react-metrics-graphics/build'

metrics-graphics is the peerDependency that is least likely to already be on a project, thus, it would be worth mention adding it to the docs.

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 with README.md, especially the installation and usage instructions for react-metrics-graphics. Verify how the peer dependencies are presented and update the documentation so the required metrics-graphics dependency is mentioned. The issue is done when a reader following the README is told to add it.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.