From eba9c7d7a45b90d29607b91de8b43e0eea4d614b Mon Sep 17 00:00:00 2001 From: Kye Date: Thu, 23 Nov 2023 20:16:24 -0800 Subject: [PATCH] contributing.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 150952c1..93916882 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,6 +51,8 @@ git push -u origin main ## 🎨 Code quality - Follow the following guide on code quality a python guide or your PR will most likely be overlooked: [CLICK HERE](https://google.github.io/styleguide/pyguide.html) + + ### Pre-commit tool This project utilizes the [pre-commit](https://pre-commit.com/) tool to maintain code quality and consistency. Before submitting a pull request or making any commits, it is important to run the pre-commit tool to ensure that your changes meet the project's guidelines. @@ -83,8 +85,6 @@ To run the pre-commit tool, follow these steps: 4. You can also install pre-commit as a git hook by execute `pre-commit install`. Every time you made `git commit` pre-commit run automatically for you. - - ### Docstrings All new functions and classes in `swarms` should include docstrings. This is a prerequisite for any new functions and classes to be added to the library.