derek
derek copied to clipboard
Consider supporting .github directory for DEREK.yaml
GitHub supports a .github directory to reduce the amount of clutter in a projects root directory for issue and contribution docs. It would be nice if DEREK.yml could also be placed there.
A potential downside is that GitHub owns the .github namespace. Alternately a directory named .automation would be nice for this type of configuration data, but pointless if only Derek uses it.
Turns out at least two other bots use .github for their config:
- probot: https://probot.github.io/apps/settings/
- tailor: https://github.com/coreos/tailor/blob/master/README.md
I see the point about projects collecting files in their root such as .travis.yml, Dockerfile and the likes.
At the moment convention over configuration means the project's code-base can remain simple.
There are lots of different integrations which have a file in the root of a repo - this does also give better visibility to the project which is provided for free. Example of the Docker project and some of the bots they use - https://github.com/moby/moby
While it is a valid point, I don't see a pressing need for this change. Thanks for logging the suggestion - I'll mark it for revisiting at a later date.