From d03e3147626e70723d8156e833617f02fc1522f9 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Fri, 15 Dec 2017 23:26:18 +0100 Subject: [PATCH] Explain eslint philosophy --- qutebrowser/javascript/.eslintrc.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/qutebrowser/javascript/.eslintrc.yaml b/qutebrowser/javascript/.eslintrc.yaml index b29deaa75..6fdd16639 100644 --- a/qutebrowser/javascript/.eslintrc.yaml +++ b/qutebrowser/javascript/.eslintrc.yaml @@ -1,3 +1,15 @@ +# qutebrowser's way of using eslint is perhaps a bit untypical: We turn on *all* +# the checks eslint has to offer, and then selectively disable/reconfigure the +# ones which got in the way below. +# +# This makes eslint much stricter (which is good). However, it means you might +# run into a case where you totally disagree with what it says, because some +# check is not useful or desired for qutebrowser, but nobody did run into it +# yet. +# +# In those cases, it's absolutely okay to modify this config as part of your PR. +# See it as a way to fine-tune eslint rather than a rigid style guide. + env: browser: true