File tree 1 file changed +5
-0
lines changed
1 file changed +5
-0
lines changed Original file line number Diff line number Diff line change @@ -71,6 +71,8 @@ Contributions are made via pull requests. Here's how to submit one:
71
71
- Try to follow the [ PEP 8] ( https://pep8.org/ ) style guide.
72
72
- Add or update tests as necessary.
73
73
- Update documentation if your changes require it.
74
+ - Run [ Ruff] ( https://docs.astral.sh/ruff/ )
75
+ - Run [ Black] ( https://pypi.org/project/black/ )
74
76
75
77
5 . ** Commit Your Changes**
76
78
@@ -104,6 +106,8 @@ Contributions are made via pull requests. Here's how to submit one:
104
106
- ** Style Guide** :
105
107
We use [ Black] ( https://pypi.org/project/black/ ) for auto formatting code in
106
108
the repo before it gets merged for style consistency.
109
+ We also use [ Ruff] ( https://docs.astral.sh/ruff/ ) for linting in the repo
110
+ before it gets merged for improving code quality.
107
111
- ** Naming Conventions** :
108
112
Use clear and descriptive names for variables, functions, and classes.
109
113
When in doubt, always try to follow [ PEP 8] ( https://pep8.org/ ) .
@@ -112,6 +116,7 @@ Contributions are made via pull requests. Here's how to submit one:
112
116
Also include type hints for functions, classes, and methods.
113
117
114
118
While not strict, try to keep documentation around 80 columns per line.
119
+ There is a hard limit of 100 columns per line of code currently.
115
120
116
121
## Testing
117
122
You can’t perform that action at this time.
0 commit comments