Skip to content

Commit

Permalink
fix: fix typo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
domingo1021 committed Jun 30, 2024
1 parent 272bc89 commit 5c169b0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ $ npm run test
- `husky`: Git hook, help to check coding style at git related hook point(e.g. **pre-commit** / **pre-push**)
- `lint-staged`: Linter for git staged files.

## Comment Priciple
## Comment Principle

1. **Class Domumentation** & **Function Documentation**: Describe the purpose of the class, methods, or function, its parameters, and its return value using JSDoc.
2. **Special Case Comments**: Use inline comments to explain complex logic, special cases, and important decisions within the code.

0 comments on commit 5c169b0

Please sign in to comment.