Skip to content

chore: update style guide#8415

Merged
gjermundgaraba merged 8 commits intomainfrom
tamjid/code-style
May 29, 2025
Merged

chore: update style guide#8415
gjermundgaraba merged 8 commits intomainfrom
tamjid/code-style

Conversation

@DeshErBojhaa
Copy link
Contributor

Description

This PR will be a discussion place to finalize our updated style guide. With the unleash the builder initiative, and new people joining the team, it's high time we solidify best practices so that the code remains in high standard.

closes: #8372


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Include changelog entry when appropriate (e.g. chores should be omitted from changelog).
  • Wrote unit and integration tests if relevant.
  • Updated documentation (docs/) if anything is changed.
  • Added godoc comments if relevant.
  • Self-reviewed Files changed in the GitHub PR explorer.
  • Provide a conventional commit message to follow the repository standards.

@codecov
Copy link

codecov bot commented May 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.68%. Comparing base (a5ad744) to head (374300c).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8415      +/-   ##
==========================================
+ Coverage   61.62%   61.68%   +0.05%     
==========================================
  Files         299      299              
  Lines       21462    21494      +32     
==========================================
+ Hits        13227    13259      +32     
  Misses       7643     7643              
  Partials      592      592              
Flag Coverage Δ
08-wasm 66.28% <ø> (ø)
e2e 1.18% <ø> (ø)
ibc-go 67.77% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@gjermundgaraba gjermundgaraba left a comment

Choose a reason for hiding this comment

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

Nice! I like the Common Mistakes section. We should be sure to update that as we see issues!

I left some comments on a few items that we can disucss :)

I wonder if there are more linters we can use with golangci-lint that would help us conform more closely to the google styleguide (separate PR for that if it exists).

@AdityaSripal
Copy link
Contributor

Nice work!! Just left a few comments

@gjermundgaraba gjermundgaraba merged commit ab224d1 into main May 29, 2025
16 of 17 checks passed
@gjermundgaraba gjermundgaraba deleted the tamjid/code-style branch May 29, 2025 18:41
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.

Go style guide refresh

3 participants