nodejs / nodejs/node-core-utils
Use asterisks for ncu-team-sync list items
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 314
- Forks
- 137
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 24
Description
Since the remark-lint rules in https://github.com/nodejs/remark-preset-lint-node enforce this, it would be good to be consent with the inserted sections, so they don't need to be ignored in the READMEs that use the tool for syncing
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 at the ncu-team-sync implementation and inspect how it renders inserted README list items, using the remark-preset-lint-node rule as the formatting reference. Done means newly inserted sections use asterisks consistently and no longer require lint exclusions in consuming READMEs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100