Skip to content

Commit 087603e

Browse files
authored
Update CONTRIBUTING.md
* Add and tweak info regarding using Ruff for linting
1 parent 3df09fe commit 087603e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ Contributions are made via pull requests. Here's how to submit one:
7171
- Try to follow the [PEP 8](https://pep8.org/) style guide.
7272
- Add or update tests as necessary.
7373
- Update documentation if your changes require it.
74+
- Run [Ruff](https://docs.astral.sh/ruff/)
75+
- Run [Black](https://pypi.org/project/black/)
7476

7577
5. **Commit Your Changes**
7678

@@ -104,6 +106,8 @@ Contributions are made via pull requests. Here's how to submit one:
104106
- **Style Guide**:
105107
We use [Black](https://pypi.org/project/black/) for auto formatting code in
106108
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.
107111
- **Naming Conventions**:
108112
Use clear and descriptive names for variables, functions, and classes.
109113
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:
112116
Also include type hints for functions, classes, and methods.
113117

114118
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.
115120

116121
## Testing
117122

0 commit comments

Comments
 (0)