Skip to content
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

chore: added debug option in cliv2 Makefile #5271

Merged
merged 2 commits into from
May 29, 2024
Merged

Conversation

ShawkyZ
Copy link
Contributor

@ShawkyZ ShawkyZ commented May 29, 2024

Pull Request Submission

Added an option to build the cliv2 go binary with flags for debugging and prevent symbol table stripping if DEBUG var is set to 1.

Usage:
DEBUG=1 make build

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@ShawkyZ ShawkyZ requested a review from a team as a code owner May 29, 2024 11:01
@ShawkyZ ShawkyZ force-pushed the chore/add-debug-build-opt branch from 06ddfef to 7f49130 Compare May 29, 2024 11:02
@ShawkyZ ShawkyZ enabled auto-merge May 29, 2024 11:02
@ShawkyZ ShawkyZ changed the title chore: added debug option in cli2 Makefile chore: added debug option in cliv2 Makefile May 29, 2024
cliv2/Makefile Outdated Show resolved Hide resolved
cliv2/Makefile Outdated Show resolved Hide resolved
@PeterSchafer
Copy link
Collaborator

Thanks @ShawkyZ for your contribution. I left you some comments, if you like to talk about the question, please let me know.

@ShawkyZ ShawkyZ requested a review from PeterSchafer May 29, 2024 15:06
Copy link
Collaborator

@PeterSchafer PeterSchafer left a comment

Choose a reason for hiding this comment

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

Praise: Very nice! Thanks for this improvements!

@ShawkyZ ShawkyZ merged commit 5bb6b1d into main May 29, 2024
15 checks passed
@ShawkyZ ShawkyZ deleted the chore/add-debug-build-opt branch May 29, 2024 16:29
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