nebari-dev / nebari-dev/nebari-docs
[DOC] - terraform is needed to run the pre-commit hooks
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
The terraform_fmt hook needs terraform to be installed in the current environment to run. This is mentioned in the requirements for this hook. This is not mentioned in the code contribution guidelines.
Might be related to #307, since there seems to be some information missing regarding the development environment.
Steps to Resolve this Issue
Add terraform as part of the development requirements
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the code contribution guidelines at /docs/community/code-contributions/, especially the pre-commit hooks section, and compare it with the terraform_fmt hook requirements linked in the issue. Update the development requirements to mention Terraform, then verify that the documented setup covers running the pre-commit hooks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- terraform
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100