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

Communicate clearly func intent #6135

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Communicate clearly func intent #6135

merged 1 commit into from
Aug 6, 2024

Conversation

jjngx
Copy link
Contributor

@jjngx jjngx commented Aug 6, 2024

Proposed changes

After merging this PR func names will communicate intent to the reader.
The naming convention follows the Go pattern of using the must (or Must) prefixes for functions that either internally call panic or make the program exit (os.Exit).

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@jjngx jjngx requested a review from a team as a code owner August 6, 2024 11:51
@github-actions github-actions bot added the go Pull requests that update Go code label Aug 6, 2024
@jjngx jjngx merged commit 3c4a3ce into main Aug 6, 2024
77 checks passed
@jjngx jjngx deleted the chore/must branch August 6, 2024 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go Pull requests that update Go code
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

3 participants