Hi! I'm really happy you want to help out with hcltm. At this early stage, the best way to get started is to Submit an Issue or Submit a PR.
I've been doing most of the work in the dev branch, and this is probably the best place to start looking at making changes.
There are a bunch of _test.go files. To run the test suite:
$ make test
Alternatively, if you want to run go vet in addition to the go test run:
$ make testvet
To check test coverage, the make testcover will open up the generated coverage output in your browser.
Please send a GitHub Pull Request to hcltm with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include tests as well. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "fix: A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Git commit messages will be auto-converted into Release change log text based on these prefixes:
feat = 'Features',
fix = 'Bug Fixes',
docs = 'Documentation',
style = 'Styles',
refactor = 'Code Refactoring',
perf = 'Performance Improvements',
test = 'Tests',
build = 'Builds',
ci = 'Continuous Integration',
chore = 'Chores',
revert = 'Reverts',
All Go code should be formatted according to https://pkg.go.dev/golang.org/x/tools/cmd/goimports. This can be validated by running:
$ make fmt
If it complains about missing goimports, run:
$ make bootstrap
All changes merged into the "main" branch will auto create a "Pre-release" https://github.com/xntrik/hcltm/releases
To release a new version:
- Update all the references to the version number to the new version, particularly the version file.
- Update the CHANGELOG
- Once the main branch has been merged and updated and all the actions are complete
git tag -a vN.N.N -m 'vN.N.N'git tag -f latestgit push --tags- This should then run a "hcltm release" action to release a new version
- From this repo, you need to push the new docker container (
VERSION=N.N.N TAG=latest make imagepush) - this may take a while :grimace: - Then don't forget to update https://github.com/xntrik/homebrew-repo
- And also https://github.com/xntrik/hcltm-action and https://github.com/xntrik/hcltm-action-example
Thanks, Christian @xntrik Frichot