-
Notifications
You must be signed in to change notification settings - Fork 348
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
Have more code conventions and guidelines #1394
Comments
Great suggestions! |
Provide a reason for ignoring tests. See #1460 |
Concept ACK, thanks for the suggestions! |
I really like this, I am totally on-board. |
Adding another comment, I think we should try to enforce such conventions as much as possible on CI + GitHub features so we can set and forget, as by experience on fedimint if it's not enforced by CI it gets hard to maintain such conventions/rules, and on CI I mean even as a simple semgrep if it does the job. |
Using rustfmt means we always agree on code formatting. If rustfmt allows it, then matters of code style can be left to personal preference.
However we could benefit from defining more code conventions in
CONTRIBUTING.md
for the sake of consistency. Just some ideas:unsafe
(or handle case by case)Approving changes:
Use case
Facilitates code review and improves readability of the codebase
Additional context
#1221
#1203 (comment)
The text was updated successfully, but these errors were encountered: