Skip to content

Commit aafc5f6

Browse files
authored
Merge pull request #2976 from port-labs/update-best-practices-file-after-qodo-talk
update the best_practices.md file with Qodo's suggestions
2 parents 307f55a + 992986a commit aafc5f6

File tree

1 file changed

+5
-21
lines changed

1 file changed

+5
-21
lines changed

best_practices.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -208,31 +208,15 @@ Example code after:
208208

209209
___
210210

211-
<b>Pattern 8: Use sentence case for headers with only the first word capitalized, and ensure links follow capitalization rules based on their position in the sentence.</b>
211+
**Header capitalization rules:** Use sentence case for headers with only the first word capitalized.
212212

213-
Example code before:
214-
215-
```
216-
## Sync Approaches And Methods
217-
218-
Check out our [Guide](docs/guide.md) for more information.
219-
```
220-
221-
Example code after:
222-
223-
```
224-
## Sync approaches and methods
225-
226-
Check out our [guide](docs/guide.md) for more information.
227-
```
213+
❌ "## Sync Approaches And Methods"
214+
✅ "## Sync approaches and methods"
228215

229216
Note: Well-known product names such as Lambda, Kubernetes, ArgoCD, etc. should follow their standard capitalization rules and styling.
230217

231-
<details><summary>Examples for relevant past discussions:</summary>
232-
233-
<!-- Add links to relevant PR discussions here -->
234-
235-
</details>
218+
❌ "aws"
219+
✅ "AWS"
236220

237221
___
238222

0 commit comments

Comments
 (0)