rabblerouser / core

Pluggable, extensible membership database for community organising
GNU Affero General Public License v3.0
17 stars 10 forks source link

Add descriptive comments in configuration files. #179

Closed bfinney-thoughtworks closed 6 years ago

bfinney-thoughtworks commented 6 years ago

This allows people to learn more about the code base when first checking it out. It also helps maintainability of the configuration files, encouraging understanding what the settings mean.

camjackson commented 6 years ago

Hi @bfinney-thoughtworks. Thanks for all the effort you put into this. A couple of us had a chat and we decided not to merge this. The reason is that all of this config is documented extensively by the maintainers of the relevant tools, and we don't want to incur the burden of maintaining our own duplicate docs for webpack/eslint/travis/etc.

I appreciate that this probably took a while to go through. Can I suggest that in the future, for a big change like this, it might be best to drop a message on slack before beginning work? That way we can avoid wasting your time 🙂