-
Notifications
You must be signed in to change notification settings - Fork 9
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
CHAL-11 #done #4
Merged
MazharulIslam-Naim
merged 17 commits into
8by8-org:development
from
dvorakjt:create-style-guide
Apr 7, 2024
Merged
CHAL-11 #done #4
MazharulIslam-Naim
merged 17 commits into
8by8-org:development
from
dvorakjt:create-style-guide
Apr 7, 2024
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
Hey Joseph, thanks for making this style guide for everyone to use; its very detailed and easy to follow. Good work. |
MazharulIslam-Naim
approved these changes
Apr 7, 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.
Checklist
[ ] Create Storybook stories for visual componentsNOT APPLICABLE, no visual components added[ ] Verify that any visual components match the FigmaNOT APPLICABLE, no visual components added[ ] Test with a screen reader (if applicable)NOT APPLICABLE, no interactive components added[ ] Document your code with TSDoc commentsNOT APPLICABLE, no TypeScript code added[ ] Format your code with PrettierNOT APPLICABLE, no TypeScript, JavaScript or JSON addedOverview
This PR creates a style guide which gives an overview of code style requirements such as conventions for naming files, cases to use for various entities, and much more. This PR also adds links to this file in README.md and CONTRIBUTING.md. The idea is that, if we have a codebase that is organized in a uniform way, it will be more more intuitive to work with.
Test Plan
I verified that the markdown rendered as expected and that code examples provided in the markdown were syntactically valid and functioned as expected. No code was added, so no other tests were necessary.
Follow ups
The style guide can continue to evolve with the team and the codebase, but for now it can be considered complete.