[No QA] update API.md with more general rules#9536
Merged
Conversation
marcochavezf
commented
Jun 22, 2022
marcochavezf
commented
Jun 22, 2022
| - Names must NOT include names of parameters eg. Bad: `SignInWithPasswordOr2FA` Good: `SignIn` | ||
| - Names must NOT the word Page or View, eg. Bad: `OpenReportPage` Good: `OpenReport` | ||
| - Names must NOT reveal backend implementation details that the user does not know about eg. `AddVBBA` (users don't know what a VBBA is - verified business bank account) Good: `AddBankAccount` | ||
| - For deep links like `StartAppWhileSignedInAndOpenWorkspace`, create separate commands for each specific scenario like `StartAppWhileSignedIn` and `OpenWorkspace`, where both requests will be triggered in parallel. |
Contributor
Author
There was a problem hiding this comment.
marcochavezf
commented
Jun 22, 2022
| - Use Create/Delete to create or destroy the only copy of data | ||
| - Use Add/Remove when we're just dealing with the copy of data | ||
| - Names must NOT include names of parameters eg. Bad: `SignInWithPasswordOr2FA` Good: `SignIn` | ||
| - Names must NOT the word Page or View, eg. Bad: `OpenReportPage` Good: `OpenReport` |
Contributor
Author
There was a problem hiding this comment.
marcochavezf
commented
Jun 22, 2022
marcochavezf
commented
Jun 22, 2022
marcochavezf
commented
Jun 22, 2022
marcochavezf
commented
Jun 22, 2022
Comment on lines
+68
to
+69
| Q: How should we remove local data from the store if the data no longer exist in the server? eg. local policy data for policies the user is no longer a member of. | ||
| A: Use Onyx.set(key, null) for each data (eg. policy) not found in the server. No newline at end of file |
Contributor
Author
There was a problem hiding this comment.
marcochavezf
commented
Jun 22, 2022
marcochavezf
changed the title
melvin-bot
Bot
requested review from
aldo-expensify
and removed request for
a team
Contributor
Author
|
Posted on n7 channel to get more 👀 |
tgolen
previously requested changes
Jun 22, 2022
tgolen
left a comment
tgolen
left a comment
Contributor
There was a problem hiding this comment.
Thanks for adding some more things to the readme!
aldo-expensify
requested changes
Jun 22, 2022
Contributor
Author
|
Updated, thanks for your comments! |
aldo-expensify
previously approved these changes
Jun 23, 2022
amyevans
reviewed
Jun 23, 2022
amyevans
previously approved these changes
Jun 23, 2022
aldo-expensify
approved these changes
Jun 24, 2022
Contributor
Author
|
Thanks for the reviews! I'm going to merge it since it was already approved before, but if there are other comments I can address them as follow-up PR |
Contributor
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
71 tasks
Contributor
|
🚀 Deployed to staging by @marcochavezf in version: 1.1.79-0 🚀
|
Contributor
|
🚀 Deployed to production by @roryabraham in version: 1.1.79-17 🚀
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Details
Add general rules discussed in the N7 channel related to the API refactoring. I linked the related slack conversation in each new bullet point.
Fixed Issues
N/A
Tests
N/A
PR Review Checklist
N/A