From edd5a3811d36f44c4fb170ff8091707c51524db8 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 24 Nov 2023 07:26:32 -0700 Subject: [PATCH] Update CONTRIBUTING.md fix name of linter quality.sh is actually called code_quality.sh --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8230322d6..c4a2299e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,7 +127,7 @@ You can learn more about mkdocs on the [mkdocs website](https://www.mkdocs.org/) `find ./tests -name '*.py' -exec pytest {} \;` ## Code Quality -`quality.sh` runs 4 different code formatters for ultra reliable code cleanup using Autopep8, Black, Ruff, YAPF +`code_quality.sh` runs 4 different code formatters for ultra reliable code cleanup using Autopep8, Black, Ruff, YAPF 1. Open your terminal. 2. Change directory to where `quality.sh` is located using `cd` command: @@ -142,7 +142,7 @@ You can learn more about mkdocs on the [mkdocs website](https://www.mkdocs.org/) 4. Run the script: ```sh - ./quality.sh + ./code_quality.sh ``` If the script requires administrative privileges, you might need to run it with `sudo`: @@ -152,9 +152,9 @@ sudo ./quality.sh Please replace `/path/to/directory` with the actual path where the `quality.sh` script is located on your system. -If you're asking for a specific content or functionality inside `quality.sh` related to YAPF or other code quality tools, you would need to edit the `quality.sh` script to include the desired commands, such as running YAPF on a directory. The contents of `quality.sh` would dictate exactly what happens when you run it. +If you're asking for a specific content or functionality inside `quality.sh` related to YAPF or other code quality tools, you would need to edit the `code_quality.sh` script to include the desired commands, such as running YAPF on a directory. The contents of `quality.sh` would dictate exactly what happens when you run it. ## 📄 license -By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/kyegomez/swarms/blob/develop/LICENSE.md). \ No newline at end of file +By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/kyegomez/swarms/blob/develop/LICENSE.md).