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

Fix grammatical errors in documentation files #382

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This pr adds user login function, includes:
<!-- The test plan section indicates detailed steps on how to verify and test code changes.
You can list the test cases or test steps that need to be performed.-->
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
Expand All @@ -21,4 +21,4 @@ Example: Issue #123
## Notes
<!-- The Important Matters section can alert others to special requirements or matters that need extra attention -->

- Example: Links and navigation need to be added to the front-end interface
- Example: Links and navigation need to be added to the front-end interface
2 changes: 1 addition & 1 deletion GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion UPGRADES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down