Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update contributions to reference pre-commit hooks #29

Open
quixoticmonk opened this issue Nov 18, 2024 · 1 comment
Open

Update contributions to reference pre-commit hooks #29

quixoticmonk opened this issue Nov 18, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@quixoticmonk
Copy link
Collaborator

Static analysis would compare the documentation generated versus what is committed.
Reference : https://github.com/aws-ia/terraform-aws-bedrock/blob/main/.project_automation/static_tests/static_tests.sh#L71
@quixoticmonk quixoticmonk added the documentation Improvements or additions to documentation label Nov 18, 2024
@scottschreckengaust
Copy link
Collaborator

scottschreckengaust commented Nov 25, 2024 •
edited
Loading

The README.md is generated from source files, and so the markdown is linting those source files directly. The pre-commit ensures the README.md has no direct edits (outside the source files).

Here are a few more details within the contributing guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@scottschreckengaust @quixoticmonk