Skip to content

Commit adcb4d8

Browse files
committed
docs: minor grammar & clarity improvements
1 parent a638240 commit adcb4d8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ scale.
3636
should be able to predict where things are located and how they are structured.
3737

3838
- **Predictability**
39-
Every file and component follows the **same structure**, reducing ambiguity. Naming conventions, folder structures,
39+
Every file and component follows a **consistent structure**, minimizing ambiguity. Naming conventions, folder structures,
4040
and function placements should remain consistent across the entire codebase.
4141

4242
- **Clarity Over Flexibility**
@@ -99,7 +99,7 @@ structure keeps related files **encapsulated** while providing clear separation
9999
- If a constant or utility **is used in more than one feature**, move it here.
100100
- **Example:** `constants/guideUtils.ts` contains `getGuideDetailsUrl` since it is used in multiple places (e.g.,
101101
dashboard & profiles).
102-
- **Feature-specific constants and utils** should remain inside the **feature folder** (e.g.,
102+
- **Feature-specific constants and utilities** should remain inside the **respective feature folder** (e.g.,
103103
`pages/profile/profileConstants.ts`).
104104

105105
- **Assets Handling**
@@ -158,6 +158,7 @@ Using **barrel files (`index.ts`)** can simplify imports and improve readability
158158

159159
- Import unnecessary code, even if unused.
160160
- Make code harder to track, increasing debugging complexity.
161+
- Wildcard imports (`import *`) force the bundler to include unused code, increasing bundle size and reducing tree-shaking efficiency.
161162

162163
```ts
163164
import * as utils from ‘common/utils’
@@ -1241,8 +1242,7 @@ export const PageRoutes = () => {
12411242
- **New feature flags must be added to featureFlags.ts**
12421243
- This ensures **visibility** and prevents unexpected feature toggles.
12431244
- **Use feature flags only for meaningful toggles**
1244-
- Avoid flagging trivial UI changes.
1245-
- Flags should be used for **significant features, redesigns, or experiments**.
1245+
- Feature flags should be reserved for **substantial feature rollouts, experiments, or redesigns**—not minor UI tweaks.
12461246
- **Local storage overrides take precedence**
12471247
- Developers can **manually toggle flags via local storage**, making testing easier.
12481248

0 commit comments

Comments
 (0)