Add aboutcode bug id to YAML front-matter for rules

[armijnhemel]

Short Description

Possible Labels

• new feature

Select Category

• Enhancement
• Add License/Copyright
• Scan Feature
• Packaging
• Documentation
• Expand Support
• Other

Describe the Update

I think it would be good to add an extra field "aboutcode-issue" or "issue" or something like that in the YAML frontmatter for the rules in the directory src/licensedcode/data/rules if there is a related issue in the issue tracker that might contain the discussion. Something similar can be done for .LICENSE files.

Example: #5067 which I added to the PR in #5098

How This Feature will help you/your organization

It makes it easier to track the history of .RULE files.

Possible Solution/Implementation Details

An extra field in the YAML frontmatter for .RULE and .LICENSE files.

Example/Links if Any

Can you help with this Feature

[armijnhemel]

Similar: #4954

[pombredanne]

Makes sense. Anything that can help traceability is a good thing.

[armijnhemel]

Another suggestion: I think that adding a namespace would make sense, for example namespace:number. This issue for example would become scancode-toolkit:5099 (if scancode-toolkit would be a good namespace). Alternative option: aboutcode-org/scancode-toolkit:5099.

Benefits:

1. no URL embedded in the bug report
2. a namespace would allow multiple origins

Drawbacks:

1. when resolving the namespace some external knowledge is needed (like which URL for the issue tracker to use)

I think that the benefits far outweigh the drawbacks.