diff --git a/.gitignore b/.gitignore index a570eae9..4598215f 100644 --- a/.gitignore +++ b/.gitignore @@ -22,8 +22,9 @@ tests/integration/*-chart-*.tgz tests/integration/inventory tests/integration/*-*.yml -# VS Code settings +# IDE and editor settings .vscode/ +.claude/ # Root coverage report for SonarCloud (generated locally or in CI) /coverage.xml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..447a2363 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,6 @@ +repos: + - repo: https://github.com/ansible/cloud-content-ci-automation + rev: precommit_hook + hooks: + - id: block-ide-ai-files + always_run: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a336063d..99020d05 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,6 +66,20 @@ After installation, you can update documentation Review the changes and create a pull request using updated files. +### Pre-Commit Hooks + +To prevent accidental commits of local configuration and IDE files (specifically `.vscode/` and `.claude/`), this repository utilizes the `pre-commit` framework. + +Please set up the hooks locally before making your first commit: + +```bash +# Install the pre-commit tool +pip install pre-commit + +# Register the hooks with Git +pre-commit install +``` + ### Code of Conduct The `kubernetes.core` collection follows the Ansible project's [Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).