Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Define the term linter. 

I heard with a new contributor that they were really confused by this
page, and I believe the key problem was that we didn't define the
somewhat technical term "linter".
This commit is contained in:
Tim Abbott 2021-06-30 15:24:15 -07:00
parent 524f0cc3d3
commit 322a9b0346
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/testing/linters.md
View File

@ -1,5 +1,11 @@
# Linters # Linters
A linter is a program that runs on the source code of software and
reports potentially problematic code to the user. Linters help enforce
coding guidelines, from minor details like whitespace formatting or
capitalization patterns for strings to preventing problematic coding
patterns that can lead to security bugs.
## Overview ## Overview
Zulip does extensive linting of much of its source code, including Zulip does extensive linting of much of its source code, including