aboutcode-org / aboutcode-org/scancode-toolkit

Add requirement for test files for each license rule

Open
#4,953 7 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

There should be a requirement that there should be a test file for each license rule that is added to the licensedb.

## Possible Labels

- new feature

## Select Category

- [x] Enhancement
- [ ] Add License/Copyright
- [ ] Scan Feature
- [ ] Packaging
- [ ] Documentation
- [ ] Expand Support
- [X] Other

## **Describe the Update**

There are currently some tests for existing rules, but not every rule has a test file:

```
$ find src/licensedcode/data/rules/ | wc -l
36483
```

```
$ find tests/licensedcode/data/datadriven/ -type f| grep yml | wc -l
4368
```

## **How This Feature will help you/your organization**

It will help catch regressions whenever new rules are added.

## **Possible Solution/Implementation Details**

Every addition to the licensedb should get a corresponding test file.

## **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.