Add documentation about using gc to src/plugins/README.md
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 38.2k
- Forks
- 6.6k
- PR merge metrics
- No merged PRs in 30d
Description
Since all plugins must support teardown, they must use `src/lib/gc.js` for modifying DOM, including adding event listeners. This needs to be documented in the plugins readme.
(Until that happens, every existing plugin uses the gc library, so just looking at existing code should help, even if it may not be obvious *why* they do that.)
Contributor guide
No contributing guide indexed for this repository
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 with src/plugins/README.md and inspect src/lib/gc.js plus existing plugins to see how teardown-related DOM changes and event listeners are handled. Document that all plugins must use gc for these changes, and consider the documentation complete when the README explains the requirement and points readers to the existing usage pattern.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100