nodejs / nodejs/node-core-utils

Use asterisks for ncu-team-sync list items

未关闭
#502 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
313
派生
137
平均合并
2 天 8 小时
30 天内合并 PR
24

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 ncu-team-sync 的实现入手,检查它如何渲染插入的 README 列表项,并以 remark-preset-lint-node 规则作为格式参考。完成的标准是:新插入的部分始终使用星号,并且使用这些内容的 README 不再需要 lint 排除项。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
cli, documentation
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。