dropbox / dropbox/dependency-guard

Feature Request: Provide more context on baseline files

Open
#108 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Kotlin
Stars
493
Forks
19
PR merge metrics
No merged PRs in 30d

Description

Compared to other code analysis tools, the baseline files of the dependency-guard plugin lack context and their existence in the repository is not really self-explanatory.

Especially on large teams, where a lot of engineers aren't actually active involved in some of the things like dependency management, I think it could be nice if the files that define baselines would contain a file header which either gives a short description what that file does, or links to the website of dependency-guard to explain what the file is and why it exists.

Prefixing them with the tool could also be helpful , like how lint baselines are are name `line-baseline.xml` and detekt baseline files are name `detekt-baseline`.

What do you think?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.