diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08487720..8230322d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,12 @@ Swarms is designed to provide modular building blocks to build scalable swarms o Before you contribute a new feature, consider submitting an Issue to discuss the feature so the community can weigh in and assist. +### Requirements: +- New class and or function Module with documentation in docstrings with error handling +- Tests using pytest in tests folder in the same module folder +- Documentation in the docs/swarms/module_name folder and then added into the mkdocs.yml + + ## How to Contribute Changes First, fork this repository to your own GitHub account. Click "fork" in the top corner of the `swarms` repository to get started: @@ -45,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. @@ -78,8 +86,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.