dropbox / dependency-guard

A Gradle plugin that guards against unintentional dependency changes.
Apache License 2.0
416 stars 15 forks source link

Feature Request: Provide more context on baseline files #108

Open remcomokveld opened 5 months ago

remcomokveld commented 5 months ago

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?