Skip to content

Commit

Permalink
update docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
alan2207 committed Jul 18, 2024
1 parent 55d518a commit b63c73d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/project-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Enforcing project standards is crucial for maintaining code quality, consistency

ESLint serves as a valuable linting tool for JavaScript, helping developers in maintaining code quality and adhering to coding standards. By configuring rules in the `.eslintrc.js` file, ESLint helps identify and prevent common errors, ensuring code correctness and promoting consistency throughout the codebase. This approach not only helps in catching mistakes early but also enforces uniformity in coding practices, thereby enhancing the overall quality and readability of the code.

[ESLint Configuration Example Code](../.eslintrc.cjs)
[ESLint Configuration Example Code](../apps/react-vite/.eslintrc.cjs)

#### Prettier

Prettier is a useful tool for maintaining consistent code formatting in your project. By enabling the "format on save" feature in your IDE, code is automatically formatted according to the rules set in the `.prettierrc` configuration file. This practice ensures a uniform code style across your codebase and provides helpful feedback on code issues. If the auto-formatting fails, it signals potential syntax error. Furthermore, Prettier can be integrated with ESLint to handle code formatting tasks alongside enforcing coding standards effectively throughout the development process.

[Prettier Configuration Example Code](../.prettierrc)
[Prettier Configuration Example Code](../apps/react-vite/.prettierrc)

#### TypeScript

Expand Down
2 changes: 1 addition & 1 deletion docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Integration testing checks how different parts of your application work together

End-to-End Testing is a method that evaluates an application as a whole. These tests involve automating the complete application, including both the frontend and backend, to confirm that the entire system functions correctly. End-to-End tests simulate how a user would interact with the application.

[E2E Example Code](../e2e/tests/smoke.spec.ts)
[E2E Example Code](../apps/react-vite/e2e/tests/smoke.spec.ts)

## Recommended Tooling:

Expand Down

0 comments on commit b63c73d

Please sign in to comment.