Skip to content

Commit ff5fa12

Browse files
committed
docs: Added Git LFS to the documentation.
1 parent d47d060 commit ff5fa12

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

CONTRIBUTING.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ The majority of development is done on macOS, so we have some helpers set-up to
1919

2020
Obviously, this won't work on Linux, so ensure that the following packages are installed from your system's package manager.
2121

22-
* Go 1.21+ (primary language)
23-
* Node.js 18+ (linting tools)
24-
* Python 3.11+ (linting tools)
25-
* `jq` (shell scripting tools)
26-
* `pre-commit` (linting tools)
22+
* [Go] 1.21+ (primary language)
23+
* [Node.js] 18+ (linting tools)
24+
* [Python] 3.11+ (linting tools)
25+
* [Git LFS] (storage of binary data)
26+
* [`jq`][jq] (shell scripting tools)
27+
* [`pre-commit`][pre-commit] (linting tools)
2728

2829
1. Running `make` in the root of the repo, by itself, will display a list of tasks and what they do. The ones highlighted in yellow are the ones that are most frequently used, or combine running multiple sub-tasks with one convenient command.
2930

@@ -529,9 +530,15 @@ To enable debugging for this Terraform provider:
529530

530531
[Cobra]: https://cobra.dev
531532
[EditorConfig]: https://editorconfig.org
533+
[Git LFS]: https://git-lfs.com
534+
[Go]: https://go.dev
532535
[golangci-lint]: https://golangci-lint.run
533536
[GoReleaser]: https://goreleaser.com
537+
[jq]: https://jqlang.github.io/jq/
534538
[Markdownlint]: https://www.npmjs.com/package/markdownlint-cli
539+
[Node.js]: https://nodejs.org
540+
[pre-commit]: https://pre-commit.com
541+
[Python]: https://www.python.org
535542
[Snyk IDE Extension]: https://docs.snyk.io/integrations/ide-tools/visual-studio-code-extension
536543
[tflint]: https://github.com/terraform-linters/tflint
537544
[yamllint]: https://github.com/adrienverge/yamllint

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ current_dir := $(dir $(mkfile_path))
1212
# Global stuff.
1313

1414
GO=$(shell which go)
15-
HOMEBREW_PACKAGES=bash bats-core coreutils findutils go jq nodejs pre-commit python@3.11 tfschema trufflesecurity/trufflehog/trufflehog
15+
HOMEBREW_PACKAGES=bash bats-core coreutils findutils git git-lfs go jq nodejs pre-commit python@3.11 tfschema trufflesecurity/trufflehog/trufflehog
1616

1717
# Determine the operating system and CPU arch.
1818
OS=$(shell uname -o | tr '[:upper:]' '[:lower:]')

0 commit comments

Comments
 (0)