openwisp / openwisp/netjsongraph.js
[change/docs] Facilitate usage, document steps to integrate in new projects
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- JavaScript
- Stars
- 314
- Forks
- 119
- Avg merge
- 18h 17m
- Merged PRs (30d)
- 15
Description
Let's try to put ourselves in the shoes of a new user that wants to use the library: what steps do they have to follow?
What files do they have to include depending on which features they want?
Should we publish this library on npm?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the library's current integration steps, feature files, and npm distribution setup. Document which steps and files a new project needs for each feature, and record a clear recommendation about whether publishing on npm is appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100