Skip to content

Developer automation and documentation#80

Merged
brandonc merged 7 commits into
mainfrom
brandonc/CONTRIBUTING
Jul 15, 2026
Merged

Developer automation and documentation#80
brandonc merged 7 commits into
mainfrom
brandonc/CONTRIBUTING

Conversation

@brandonc

Copy link
Copy Markdown
Collaborator

Description

  • Adds make help as the default task, showing all the make targets
  • Adds make targets for developer tool installation, CI checks, etc
  • Adds CONTRIBUTING.md containing basic requirements and an architecture overview

PR Checklist

  • Run npx changie new or install changie to prepare a new changelog entry for the next set of release notes.

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.

  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.

  • If applicable, I've documented the impact of any changes to security controls.

    Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

@brandonc
brandonc force-pushed the brandonc/CONTRIBUTING branch from 42c77aa to 75e4a2b Compare July 14, 2026 21:30
@brandonc
brandonc force-pushed the brandonc/CONTRIBUTING branch from 75e4a2b to f4d3e73 Compare July 14, 2026 21:31
Comment thread CONTRIBUTING.md Outdated
git clone https://github.com/hashicorp/tfctl-cli
cd tfctl-cli
scripts/setup.sh # Install toolchain and dev tools
make build # Build

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make build isn't a target in the Makefile

Comment thread .github/workflows/ci.yml Outdated
uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # v9.2.0
with:
version: v2.12
- name: Install tools

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make tools is slower than golangci-lint-action, why are we removing? Maybe we can keep the pinned action for lint and using make only for the extra checks?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. I'll put it back. I was trying to consolidate versions because CI always differs from local

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can always read the version in a step and use it as the version input

Comment thread .github/dependabot.yml
schedule:
interval: "weekly"
labels:
- dependencies

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dependencies label doesn't exist in this repo

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created

@brandonc
brandonc merged commit 9363707 into main Jul 15, 2026
2 checks passed
@brandonc
brandonc deleted the brandonc/CONTRIBUTING branch July 15, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants