Precise event naming convention #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
|
|
||
| Events should track things that _happened_ and so should be past tense. Using past tense also helps avoid naming collisions with structs or functions. | ||
| Events should track things that _happened_ and so should be past tense. Using past tense also helps avoid naming collisions with structs or functions. We also recommend following the `WhatAction`(e.g. `OwnerUpdated`) format rather than `ActionWhat` (e.g. `UpdatedOwner`). |
There was a problem hiding this comment.
Maybe more clear to use parts of speech naming?
Suggested change
| Events should track things that _happened_ and so should be past tense. Using past tense also helps avoid naming collisions with structs or functions. We also recommend following the `WhatAction`(e.g. `OwnerUpdated`) format rather than `ActionWhat` (e.g. `UpdatedOwner`). | |
| Events should track things that _happened_ and so should be past tense. Using past tense also helps avoid naming collisions with structs or functions. We also recommend following the `SubjectVerb`(e.g. `OwnerUpdated`) format rather than `VerbSubject` (e.g. `UpdatedOwner`). |
|
+1 to this! |
README.md
Outdated
|
|
||
| Events should track things that _happened_ and so should be past tense. Using past tense also helps avoid naming collisions with structs or functions. | ||
| Events should track things that _happened_ and so should be past tense. Using past tense also helps avoid naming collisions with structs or functions. We also recommend following the `SubjectVerb`(e.g. `OwnerUpdated`) format rather than `VerbSubject` (e.g. `UpdatedOwner`). |
There was a problem hiding this comment.
Sorry @xenoliss one more comment here. I think We also recommend... could be its own rule? Not sure we need to bundle with past tense
README.md
Outdated
| event OwnerUpdated(address newOwner); | ||
| ``` | ||
|
|
||
| ##### B. Prefer `SubjectVerb` naming format |
There was a problem hiding this comment.
Suggested change
| ##### B. Prefer `SubjectVerb` naming format | |
| ##### B. Prefer `SubjectVerb` naming format. |
wilsoncusack
approved these changes
Apr 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In addition to recommending the usage of past tense for events naming, this PR further advise to follow a
WhatAction(e.g.OwnerUpdated) format rather thanActionWhat(e.g.UpdatedOwner).