Update formatting and lintting

owasp-noir · Nov 11, 2023 · 604a50f · 604a50f
1 parent 8fcbb2a
commit 604a50f
Showing 1 changed file with 15 additions and 5 deletions.
diff --git a/docs/contribute/linting.md b/docs/contribute/linting.md
@@ -1,15 +1,25 @@
 ---
 layout: page
-title: Linting
-permalink: /contribute/linting
+title: Formatting and Linting
+permalink: /contribute/formatting_linting
 parent: Contribute
 nav_order: 5
 ---
 
+## Formatting
 ```bash
 crystal tool format
+```
+
+## Linting
+You align code conventions using Ameba. Refer to the link [https://github.com/crystal-ameba/ameba#installation](https://github.com/crystal-ameba/ameba#installation) to install Ameba.
+
+```bash
+# Basic
+ameba
+
+# Auto fix
 ameba --fix
+```
 
-# Ameba installation
-# https://github.com/crystal-ameba/ameba#installation
-```
+*Ameba conf: [.ameba.yml](https://github.com/noir-cr/noir/blob/main/.ameba.yml)*