-
Notifications
You must be signed in to change notification settings - Fork 345
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
π Contribution guidelines #19
Comments
5 tasks
Approve |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Most of the stuff here are similar to solmate's.
Points that are specific to solady are marked with a β‘.
Emoji key for Issues and PRs
Format:
<emoji><space><Title>
Styling
`b`
). β‘0x20
). β‘This is to convey semantic meaning, and aid readability for binary / hexadecimal natives.
ALL_CAPS
. If it is a private or internal constant in a contract, prefix it with an underscore. β‘testDescription
. Let's normalize fuzz testing. β‘File naming
Let's stick to solmate's, to maintain drop-in compatibility for the select few classes and libraries we have.
It's a mouthfeel over consistency thing.
Compiler / Transpiler safety
Make sure your PR's are compilable with
--via-ir
. β‘Care must be taken when using the
slot
keyword in Yul,to ensure that the code is compatible with upgradeable contract transpilers. β‘
Others
Our
SafeTransferLib
library acceptsaddress
instead ofERC20
. β‘This is intentional for better cross-compatibility with OpenZeppelin.
The text was updated successfully, but these errors were encountered: