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

[Proposal] Coding Standards #28489

Open
d0cd opened this issue Jan 22, 2025 · 0 comments
Open

[Proposal] Coding Standards #28489

d0cd opened this issue Jan 22, 2025 · 0 comments
Assignees
Labels
proposal A proposal for something new.

Comments

@d0cd
Copy link
Collaborator

d0cd commented Jan 22, 2025

💥 Proposal

We propose the following coding standards for Leo:

  • If code is unreachable for all invocations, use the unreachable! macro.
  • Do not use unwraps, use expect with a reason, assert!, or a test-and-panic.
  • Every struct, struct member, and function should have a comment explaining what it does. If it's a public item, use a doc comment.

TODO

Existing Leo needs to be updated to this standard.

@d0cd d0cd added the proposal A proposal for something new. label Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal A proposal for something new.
Projects
None yet
Development

No branches or pull requests

2 participants