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

CHAL-11 #done #4

Merged
merged 17 commits into from
Apr 7, 2024

Conversation

dvorakjt
Copy link
Contributor

@dvorakjt dvorakjt commented Apr 4, 2024

Checklist

  • Include the corresponding Jira issue key and #done in the PR title, like so: "JRA-123 #done Migrate Election Reminders"
  • Verify that the code compiles
  • Verify that all tests pass
  • Verify that unit tests cover 100% of the code
  • [ ] Create Storybook stories for visual components NOT APPLICABLE, no visual components added
  • [ ] Verify that any visual components match the Figma NOT APPLICABLE, no visual components added
  • [ ] Test with a screen reader (if applicable) NOT APPLICABLE, no interactive components added
  • [ ] Document your code with TSDoc comments NOT APPLICABLE, no TypeScript code added
  • [ ] Format your code with Prettier NOT APPLICABLE, no TypeScript, JavaScript or JSON added

Overview

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.

@MazharulIslam-Naim
Copy link
Member

Hey Joseph, thanks for making this style guide for everyone to use; its very detailed and easy to follow. Good work.

@MazharulIslam-Naim MazharulIslam-Naim merged commit 1b4fdb0 into 8by8-org:development Apr 7, 2024
1 check passed
@dvorakjt dvorakjt deleted the create-style-guide branch April 22, 2024 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants