diff --git a/docs/contribute/linting.md b/docs/contribute/linting.md index 2329377..427278f 100644 --- 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 -``` \ No newline at end of file +*Ameba conf: [.ameba.yml](https://github.com/noir-cr/noir/blob/main/.ameba.yml)* \ No newline at end of file