DEV Community

Josua Schmid for Renuo AG

Posted on

Much Compliance and Config

Dear developers

Please refrain from creating GitHub repositories like this one:

GitHub directory tree

The main thing you want to show me is your code. What you need is the following:

  • (maybe, mention it in
  • main.js
  • package.json, package-lock.json
  • .env.sample (maybe)

These are 6 files. I don't want to juggle 16 files in my brain to find what I'm looking for in the repo root directory. Please use folders to hide what one doesn't need to see at a first glance.

If you want another example of how all this configuration madness spoils my greppability of code bases, have a look at what JavaScript did to Rails in my May of WTF post.

Top comments (0)