springernature / eslint-config-springernature

ESLint shareable config used at Springer Nature
MIT License
3 stars 0 forks source link

Add documentation for overriding configuration settings #57

Open RSeidelsohn opened 4 months ago

RSeidelsohn commented 4 months ago

In yesterdays frontend open space, we had a discussion about ESLint configuration. As a result, I have agreed to review and update or enhance our frontend playbook and the eslint-config-springernature documentation.

Among other details, we discussed the configuration setting for specific ECMAScript versions. This repository uses ECMAScript 6 in the ESLint configuration, which might be outdated for actual projects that import eslint-config-springernature. This is even more of a concern when it's used in a completely new project, that would want to use more modern versions of ECMAScript.

I added new sections and changed an existing headline with the intention of giving developers more confidence in their ESLint configuration.

Please have a look and add your comments and changes.