feat: first draft of conventions doc #1615
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
priya-chatwani
force-pushed
the
feat/add-conventions
branch
from
1507643 to
5dbc83f
Compare
hiemanshu
approved these changes
May 30, 2023
There was a problem hiding this comment.
Overall LGTM!
For Components:
-
Use
graphql-codegenand import graphql types from@spoke/spoke-codegenwhere appropriate. -
When working with old class type components, which might be a bad candidate for immediate refactor, refactor the GraphQL queries to import
QueryDocumentfrom@spoke/spoke-codegen
Style:
- Prefer using
theme.palettecolors over direct definition of colors. If direct definition is required, import and use colors from@material-ui/core/colors
|
@bchrobot would love your eyes on this as well. |
priya-chatwani
force-pushed
the
feat/add-conventions
branch
from
5dbc83f to
eb78129
Compare
ajohn25
pushed a commit
to With-the-Ranks/Spoke
that referenced
this pull request
Sep 10, 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.
Description
First pass of a conventions doc
Motivation and Context
#1146
How Has This Been Tested?
Screenshots (if appropriate):
Documentation Changes
conventions.mdChecklist: