mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-03 21:43:21 +00:00 
			
		
		
		
	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:
		@@ -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
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user