cisagov / cisagov/skeleton-tf-module

Create or find a `pre-commit` hook

Open
#197 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Shell
Stars
5
Forks
4
Avg merge
17m
Merged PRs (30d)
1

Description

# 💡 Summary #

Create or find a `pre-commit` hook that fails if running the script from #196 actually changes anything.

## Motivation and context ##

This would force users to update the Terraform documentation whenever necessary.

## Implementation notes ##

Requires #196 as a prerequisite.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing issue #196 and the repository's existing hook configuration, since this issue depends on that script. Verify that the pre-commit hook detects changes made by the script and fails when Terraform documentation is modified; done means the hook enforces that check.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell, terraform
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.