Skip to content

Commit

Permalink
Update CONTRIBUTING.md fix name of linter
Browse files Browse the repository at this point in the history
quality.sh is actually called code_quality.sh
  • Loading branch information
evelynmitchell authored Nov 24, 2023
1 parent 36a641b commit edd5a38
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`:
Expand All @@ -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).
By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/kyegomez/swarms/blob/develop/LICENSE.md).

0 comments on commit edd5a38

Please sign in to comment.