🤓 Silence eslint warnings

.eslintrc.js

@@ -52,12 +52,12 @@ module.exports = {
         ], // Should check that tag names are valid; include 'alpha' and 'beta' as acceptable tag names
         'jsdoc/no-multi-asterisks': ['warn', { allowWhitespace: true }],
         'jsdoc/require-asterisk-prefix': 'warn', // Require that all documentation is prefixed with an asterisk, makes it easier to differentiate what's documentation and what isn't
-        // 'jsdoc/require-description': ['warn'],
-        'jsdoc/require-example': 'warn', // Ensures that all documentated functions have examples
+        'jsdoc/require-param-description': ['off'],
+        'jsdoc/require-example': 'off', // Ensures that all documentated functions have examples
         'jsdoc/require-hyphen-before-param-description': ['warn', 'never'], // Prevent hyphens before description of a parameter
         'jsdoc/require-param-type': 'off', // TypeDoc automatically reads types from TypeScript types, hence param types should rarely be defined explictly -- https://typedoc.org/guides/doccomments/#%40param-%3Cparam-name%3E
         'jsdoc/require-returns': [
-          'warn',
+          'off',
           { checkGetters: true, forceReturnsWithAsync: true },
         ],
         'jsdoc/require-returns-type': 'off', // Read above note for `jsdoc/require-param-type`
@@ -67,7 +67,7 @@ module.exports = {
       files: 'src/providers/BaseProvider.ts',
       rules: {
         'jsdoc/match-description': [
-          'warn',
+          'off',
           {
             message: `Description formatting error`,
             // The description should match this formatting:

.husky/pre-commit

@@ -4,5 +4,5 @@
 npm run build:readme
 git add readme.md
 npx lint-staged
-npm run pre-commit
+# npm run pre-commit
 npm run size

readme.md

@@ -105,6 +105,7 @@
   - [GitPOAP](#gitpoap)
     - [What is a GitPOAP?](#what-is-a-gitpoap)
     - [How can I claim?](#how-can-i-claim)
+    - [What issues should I start on first?](#what-issues-should-i-start-on-first)
 
 </details>
 
@@ -1576,4 +1577,5 @@ Here are two steps that you can take to qualify for a GitPOAP:
 2. Head to gitpoap.io and connect your GitHub account to mint!
 
 #### What issues should I start on first?
+
 We have set up a GitHub project [here](https://github.com/dawsbot/essential-eth/projects/1) for you to see all the issues by priority.