opensearch-project / demos

Apache License 2.0
2 stars 13 forks source link

Added pre-commit type-checking #99

Open miriamcheng opened 8 months ago

miriamcheng commented 8 months ago

Description

Added pre-commit type-checking using mypy. Written by Mekaeel and Miriam

Pre-commit type-checks and style-checks (not yet) your code before you commit them. It is recommended that you do this before making commitments. STEP 1: Install pre-commit pip install pre-commit STEP 2: Set up pre-commit hooks: navigate to local repository and activate pre-commit hooks

cd /path/to/your/project
pre-commit install

STEP 3: Test pre-commit hooks pre-commit run --all-files By doing this, users can help to identify and fix issues before they are committed to the repository.

Issues Resolved

This contributes to issue #92, but we still need to verify that all types are working. It clearly shows issues for cluster-bootstrapping.py which need to be addressed.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.