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.

Sign up for GitHub

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

Jump to bottom

doc: add style guide #660

Merged
merged 1 commit into from
Sep 12, 2024
Merged

doc: add style guide #660

merged 1 commit into from
Sep 12, 2024

Conversation

Wodann
Copy link
Member

@Wodann Wodann commented Sep 10, 2024

Proposal for adding guidelines around code style

@Wodann Wodann added the no changeset needed This PR doesn't require a changeset label Sep 10, 2024
@Wodann Wodann requested a review from a team September 10, 2024 22:13
@Wodann Wodann self-assigned this Sep 10, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 10, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 9c8ea3b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Wodann Wodann temporarily deployed to github-action-benchmark September 10, 2024 22:13 — with GitHub Actions Inactive
agostbiro
agostbiro reviewed Sep 11, 2024
View reviewed changes
book/src/02_development/06_style_guide.md

### Member functions

For member functions, use the following default rules to order them:
Copy link
Member

Choose a reason for hiding this comment

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

"default rules" -- I'm assuming this means it's ok to deviate if it makes sense? Would be good to make it more explicit if possible

Copy link
Member Author

Choose a reason for hiding this comment

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

Addressed in d1a250f

agostbiro
agostbiro approved these changes Sep 11, 2024
View reviewed changes
Copy link
Member

@agostbiro agostbiro left a comment

Choose a reason for hiding this comment

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

Thanks for this! I left one comment, but approving to unblock merging

Xanewok
Xanewok approved these changes Sep 11, 2024
View reviewed changes
book/src/02_development/06_style_guide.md Outdated Show resolved Hide resolved
@Wodann Wodann temporarily deployed to github-action-benchmark September 11, 2024 17:37 — with GitHub Actions Inactive
@Wodann Wodann temporarily deployed to github-action-benchmark September 11, 2024 23:29 — with GitHub Actions Inactive
@Wodann @Xanewok
doc: add style guide
9c8ea3b 
Co-authored-by: Igor Matuszewski <[email protected]>
@Wodann Wodann temporarily deployed to github-action-benchmark September 12, 2024 18:58 — with GitHub Actions Inactive
@Wodann Wodann added this pull request to the merge queue Sep 12, 2024
Merged via the queue into main with commit 7080c8d Sep 12, 2024
17 checks passed
@Wodann Wodann deleted the doc/style-guide branch September 12, 2024 18:58
@CindaiMKR
Copy link

$ npx hardhat node
Started HTTP and WebSocket JSON-RPC server at http://127.0.0.1:8545/

Accounts

Account #0: 0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266 (10000 ETH)
Private Key: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

Account #1: 0x70997970c51812dc3a010c7d01b50e0d17dc79c8 (10000 ETH)
Private Key: 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fvictorio fvictorio fvictorio approved these changes

@Xanewok Xanewok Xanewok approved these changes

@agostbiro agostbiro agostbiro approved these changes

Assignees

@Wodann Wodann

Labels
no changeset needed This PR doesn't require a changeset
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Wodann @CindaiMKR @fvictorio @Xanewok @agostbiro