Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add FAQ for linting errors #6157

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from
13 changes: 13 additions & 0 deletions docs/contributing/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ limitations under the License.
- [How can I install cppcheck?](#install-cppcheck)
- [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
- [What should I do if Javascript linting on my commits fails because my function exceed the maximum permissible number of parameters?](#max-params)
- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
- [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
Expand Down Expand Up @@ -111,6 +112,18 @@ Consider whether the heading can be shortened by renaming variables (e.g., chang

TODO: Can we add a reference PR link?

<a name="markdown-heading-length"></a>

## What should I do if Javascript linting on my commits fails because my headings exceed the maximum permissible number of parameters?

Consider whether the number of parameters can be reduced. If reducing is not possible, disable the lint rule at the top level using:

```javascript
/* eslint-disable max-params */
```

TODO: Can we add a reference PR link?

<a name="pr-feedback"></a>

## I have opened a pull request, where can I seek feedback?
Expand Down