-
Notifications
You must be signed in to change notification settings - Fork 12
chore: improve Makefile and add PR checklist #334
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.
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
base: main
Are you sure you want to change the base?
Conversation
Plus regenerated files which had been missed in previous PRs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -0,0 +1,9 @@ | |||
### Description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Praise: Nice, long overdue!
|
||
- [ ] Tests added and all succeed (`make test`) | ||
- [ ] Regenerated mocks, etc. (`make generate`) | ||
- [ ] Linted (`make lint`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: let's add a point to integrate this in the CLI to ensure early that the changes didn't break anything.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something like this?:
- Test your changes integrated into the CLI
- To test locally uncomment the relevant
replace
line in cliv2/go.mod
- To test locally uncomment the relevant
Or were you thinking they should create a draft PR ready? So adding "If required, create a draft PR on the CLI repo."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we had past occasions where gaf changes broke the CLI and its Acceptance tests, I would say open a PR to test and after merging in gaf ensure to merge in the CLI
as well. otherwise we will see multiple changes coming to the CLI at once just because they were never integrated there before making it difficult to debug.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"open a PR to test", I'm not sure I follow how opening a PR would test it, unless you are suggesting that the person updates the go.mod in the CLI PR to point to their GAF PR's commit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @PeterSchafer, I've given the wording an attempt, let me know what you think.
Plus regenerated files which had been missed in previous PRs.
For reference, here is the PR checklist for the LS: https://github.com/snyk/snyk-ls/blob/main/.github/pull_request_template.md