aboutcode-org / aboutcode-org/scancode.io

Provide documentation for "ignored" rules

未关闭
#409 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
design-needed documentation medium priority
主要语言
Python
星标
215
派生
203
平均合并
4 天 8 小时
30 天内合并 PR
6

描述

We need to document the internal rules from SCTK and SCIO that determine what files are reported as "uninteresting" or not reported at all. Two examples are:
- ignore.py in commoncode: https://github.com/nexB/commoncode/blob/653225d58dcf5d1f75dbe572cac13f6d84ae755b/src/commoncode/ignore.py#L63 has a long list of files ignored (not reported) by SCTK.
- rootfs.py in scancode.io: https://github.com/nexB/scancode.io/blob/main/scanpipe/pipes/rootfs.py has a list of rootfs directories that we report, but label as "ignored-not-interesting".

In both cases the most important thing is to document the existence of these rules and the second priority is to document the rules themselves. We need to start by updating the SCIO documentation to explain why we have these rules and provide a link to where they are in the code. Longer term we need to figure out how to automate documentation of rules within our software.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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