aboutcode-org / aboutcode-org/scancode-toolkit

Add aboutcode bug id to YAML front-matter for rules

Open
#5,099 3 comments 0 reactions 0 assignees View on GitHub
new feature
Dominant language
Python
Stars
2.6k
Forks
791
Avg merge
1d 12h
Merged PRs (30d)
5

Description

## Short Description

## Possible Labels

- new feature

## Select Category

- [X] 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**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.