no developers md -> contributing md

pull/307/head
Kye 1 year ago committed by Zack
parent 474e04ce8d
commit cebc10f0c0

@ -51,8 +51,6 @@ git push -u origin main
## 🎨 Code quality ## 🎨 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) - 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 ### 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. 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.
@ -85,6 +83,8 @@ 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. 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 ### 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. 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.

@ -77,18 +77,11 @@ mypy-protobuf = "^3.0.0"
[tool.autopep8] [tool.autopep8]
max_line_length = 70 max_line_length = 80
ignore = "E501,W6" # or ["E501", "W6"] ignore = "E501,W6" # or ["E501", "W6"]
in-place = true in-place = true
recursive = true recursive = true
aggressive = 3 aggressive = 3
[tool.ruff] [tool.ruff]
line-length = 70 line-length = 80
[tool.black]
line-length = 70
target-version = ['py38']
preview = true

Loading…
Cancel
Save