Feature Request: Provide more context on baseline files

[remcomokveld]

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?

[handstandsam]

Instead of src/dependencies, it could be src/dependency-guard. That feels like it might address what you're looking for? That being said... it's a breaking change and would require a major version change. I like the idea though.

The idea of providing a custom header to the baseline file is interesting. That doesn't seem unreasonable but would need to define what that syntax is. It would cause adjustment of all existing parsers/etc as well. Thoughts?