mirror of
https://github.com/cpvalente/ontime.git
synced 2026-08-30 03:19:11 +00:00
docs(llm): request for useeffect documentation
This commit is contained in:
committed by
Carlos Valente
parent
4c08ca2908
commit
9ec12f4927
@@ -36,6 +36,10 @@ Remove comments that:
|
||||
|
||||
Update adjacent comments with code. Stale comments are defects.
|
||||
|
||||
Add a short comment immediately above every React `useEffect` describing the external synchronization or lifecycle
|
||||
responsibility it owns. Explain non-obvious reasons or constraints when they matter; for files with multiple effects, a
|
||||
brief responsibility label is useful even when the mechanics are straightforward.
|
||||
|
||||
## Naming and types
|
||||
|
||||
- Prefer Ontime terms over vague `data`, `result`, `item`.
|
||||
|
||||
Reference in New Issue
Block a user