@@ -25,8 +25,7 @@ As a writer for CodeCut, your role is to:
25
25
- Break down complex tools and workflows into clear, digestible pieces
26
26
- Focus on practical value over theoretical depth
27
27
- Maintain a tone that is approachable, confident, and helpful
28
- - Write only about topics you are genuinely interested in
29
- - Enjoy the writing process—we want this to be fun for you, too
28
+ - Show rather than tell - use code snippets, visuals, or graphs to demonstrate your points
30
29
31
30
## Writing Checklist
32
31
@@ -37,7 +36,7 @@ You can check off these items directly in your IDE (such as VS Code, PyCharm, or
37
36
### Writing Style Checklist
38
37
39
38
- [ ] Use action verbs instead of passive voice
40
- - [ ] Limit paragraphs to 2-4 sentences
39
+ - [ ] Limit paragraphs to 2 sentences. If the paragraph explains a code snippet or workflow, consider using bullet points to make it easier to follow.
41
40
- [ ] For every major code block, provide a clear explanation of what it does and why it matters.
42
41
- [ ] Structure content for quick scanning with clear headings and bullet points
43
42
@@ -166,5 +165,4 @@ The exported HTML files will be automatically deployed to GitHub Pages through t
166
165
# Push your changes to your fork
167
166
git push origin feature/your-feature-name
168
167
# Then go to GitHub and click "Create Pull Request"
169
- ```
170
-
168
+ ```
0 commit comments