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: migrate upgrade snyk go dependencies to go #5150

Closed

Conversation

thisislawatts
Copy link
Member

Pull Request Submission

Please check the boxes once done.

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?

Drop a python script in favour of a go one, the rationale for this aside from me writing some more go is:

Consistency in Tooling and Syntax:

Our CLI codebase already uses 2 languages Go and Typescript, dropping a Python script ensures consistency in tooling, syntax, and coding conventions. Developers don't need to switch between as many different languages, which reduces cognitive load by allowing them to stay focused on the language and patterns they are already familiar with.

Reduced Context Switching:

Context switching between different languages can be mentally taxing for developers, as they need to remember the syntax, libraries, and best practices specific to each language. By using Go throughout the codebase, including scripts, developers can avoid this context switching, leading to better productivity and reduced mental fatigue.

Easier Code Maintenance:

Having a uniform codebase makes it easier to onboard new developers to the project. They only need to learn one language and its associated ecosystem, which streamlines the learning curve and accelerates their ability to contribute effectively.
Additionally, maintaining a single language codebase simplifies code reviews, debugging, and refactoring processes. Developers can leverage their expertise in Go to navigate and enhance the entire codebase more efficiently.
Incorporating these points into the benefits of using a Go script reinforces the idea that reducing cognitive overhead is crucial for developer productivity, code quality, and long-term maintainability within a Go-focused environment.

Our primary languages for the CLI are Typescript and Go. Whilst
Python is useful for scripting it introduces unnecessary overhead
for contributors. Reducing the number of languages required reduces
maintenance costs in the longer term.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant