diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e5b24e295..b425a11c3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ This pr adds user login function, includes: Example: -- 1. Use different test accounts for login tests, including correct user names and passwords, and incorrect user names and passwords. +- 1. Use different test accounts for login tests, including correct usernames and passwords, and incorrect usernames and passwords. - 2. ... ## Related Issue @@ -21,4 +21,4 @@ Example: Issue #123 ## Notes -- Example: Links and navigation need to be added to the front-end interface \ No newline at end of file +- Example: Links and navigation need to be added to the front-end interface diff --git a/GUIDELINES.md b/GUIDELINES.md index a62372024..1b697eb30 100644 --- a/GUIDELINES.md +++ b/GUIDELINES.md @@ -6,7 +6,7 @@ Code must be thoroughly tested with quality unit tests. We defer to the [Foundry Best Practices](https://book.getfoundry.sh/tutorials/best-practices) and [Moloch Testing Guide](https://github.com/MolochVentures/moloch/tree/master/test#readme) for specific recommendations, though not all of it is relevant here. Note the introduction in Moloch Testing Guide: -> Tests should be written, not only to verify correctness of the target code, but to be comprehensively reviewed by other programmers. Therefore, for mission critical Solidity code, the quality of the tests are just as important (if not more so) than the code itself, and should be written with the highest standards of clarity and elegance. +> Tests should be written, not only to verify correctness of the target code, but to be comprehensively reviewed by other programmers. Therefore, for mission-critical Solidity code, the quality of the tests are just as important (if not more so) than the code itself, and should be written with the highest standards of clarity and elegance. Every addition or change to the code must come with relevant and comprehensive tests. diff --git a/UPGRADES.md b/UPGRADES.md index c8578fd35..67ffcae0f 100644 --- a/UPGRADES.md +++ b/UPGRADES.md @@ -58,7 +58,7 @@ Note, some are going to be false positives, especially Solady and UpgradeableBea ## 3. Write a script to deploy the new contracts and implementations Inherit from UpgradedImplHelper to compile the upgrade structs that `_writeUpgradeProposals()` need to generate the output file -Upgrading is a multi step process, we need to schedule first, then execute. Having an intermediary file helps the auditability +Upgrading is a multi-step process, we need to schedule first, then execute. Having an intermediary file helps the auditability of the process. Remember to use CREATE3 for new proxy contracts