-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Description
Why This Is Important
- Consistency: Ensures all contributors follow the same code style and import ordering.
- Quality: Improves readability and maintainability of the codebase.
- Reliability: Prevents style-related issues from slipping into production.
Tasks
- Add
pre-commitconfiguration file (.pre-commit-config.yaml) to the repository. - Configure hooks for
black(code formatter) andisort(import sorter). - Install
pre-commitin the development environment (pip install pre-commit). - Run
pre-commit installto enable hooks locally. - Test by committing code to verify that formatting and import sorting are applied automatically.
- Update documentation (README or contributing guide) to explain usage.
Acceptance Criteria
.pre-commit-config.yamlexists withblackandisorthooks configured.- Developers can run
pre-commit installand see hooks applied on commit. - Code is automatically formatted with
blackand imports sorted withisort. - Documentation updated to guide contributors on setup and usage.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels