@@ -24,6 +24,45 @@ redisctl/
2424└── docs/ # mdBook documentation
2525```
2626
27+ ## Writing Style for Documentation and PRs
28+
29+ ** CRITICAL** : Follow these strict guidelines for all documentation, commit messages, and PR descriptions:
30+
31+ ### What to AVOID
32+ - ❌ ** No emojis** - Never use emojis in commits, PRs, or code (✅ ❌ 🚀 etc.)
33+ - ❌ ** No marketing language** - Avoid "exciting", "powerful", "seamless", "game-changing", etc.
34+ - ❌ ** No superlatives** - Don't use "best", "perfect", "amazing", "incredible"
35+ - ❌ ** No hype** - Write factual, technical descriptions only
36+ - ❌ ** No exclamation points** - Use periods for professional tone
37+
38+ ### What to DO
39+ - ✓ Use ** technical, factual language**
40+ - ✓ Focus on ** what changed and why**
41+ - ✓ Be ** specific and concrete**
42+ - ✓ Use ** imperative mood for commits** (e.g., "Add feature" not "Added feature")
43+ - ✓ Reference ** issue numbers** where applicable
44+
45+ ### Examples
46+
47+ ** Bad** :
48+ ```
49+ 🚀 feat: Add amazing support package upload feature!
50+
51+ This exciting new feature seamlessly integrates with Files.com to provide
52+ a powerful solution for uploading support packages! ✨
53+ ```
54+
55+ ** Good** :
56+ ```
57+ feat: add support package upload with Files.com integration
58+
59+ Implements support package upload to Files.com via files-sdk 0.3.1.
60+ Adds --upload and --no-save flags to support-package commands.
61+ Supports environment variable and secure keyring storage for API keys.
62+
63+ Closes #123
64+ ```
65+
2766## Build and Development Commands
2867
2968### Essential Commands
0 commit comments