Establish project coding standards & guidelines #581
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@Hunter275 I'd love to get your thoughts on this |
danditomaso
changed the title
Hunter275
reviewed
Apr 24, 2025
| - **Readability:** Write code that is easy for others (and your future self) to | ||
| understand. | ||
| - **Consistency:** Adhere to these guidelines to maintain a consistent codebase. | ||
| - **Simplicity (KISS):** Keep components and functions focused and avoid |
There was a problem hiding this comment.
I know what KISS means but maybe others don't
| - **Reducer (`useReducer`):** Use for complex state logic involving multiple | ||
| sub-values or when the next state depends on the previous one, especially | ||
| within a single component or closely related components (can be co-located). | ||
| - **Global State (Zustand):** Use Zustand for managing application-wide state. |
|
|
||
| ## Testing | ||
|
|
||
| - **Test Framework (Vitest):** Use Vitest for all levels of automated testing, |
| - **Test Framework (Vitest):** Use Vitest for all levels of automated testing, | ||
| including unit, integration, and component tests. Global test | ||
| configuration/setup files reside in `/src/tests`. | ||
| - **Component Testing (React Testing Library):** Utilize React Testing Library |
|
|
||
| **Core Principle: Minimize Bundle Size** | ||
|
|
||
| A primary goal of this project is to maintain a small and performant application |
There was a problem hiding this comment.
Maybe add something about this being bundled onto SBCs or devices with very little memory
| complexity. Therefore, we prioritize minimizing the number of third-party | ||
| libraries. | ||
|
|
||
| **Guidelines:** |
There was a problem hiding this comment.
Rename "Dependency & Library Guidelines"
|
How do you plan to enforce these requirements? |
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
This PR introduces
CODING_GUIDELINES.mdwhich is expected to provide guidelines for developers contributing to the project.This includes coding standards, preferred tools (Deno, Vitest, Zustand, Tailwind), file organization, testing requirements, and library dependency usage philosophy to ensure consistency.
Changes Made