aboutcode-org / aboutcode-org/scancode.io

Provide documentation for "ignored" rules

オープン
#409 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る
design-needed documentation medium priority
主要言語
Python
スター
215
フォーク
203
平均マージ
4日 8時間
マージ済み PR(30日)
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 を短くまとめたダイジェスト。