Skip to content

Commit 7bbc339

Browse files
edit contribution guideline
1 parent 201cf10 commit 7bbc339

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

contribution.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ As a writer for CodeCut, your role is to:
2525
- Break down complex tools and workflows into clear, digestible pieces
2626
- Focus on practical value over theoretical depth
2727
- 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
3029

3130
## Writing Checklist
3231

@@ -37,7 +36,7 @@ You can check off these items directly in your IDE (such as VS Code, PyCharm, or
3736
### Writing Style Checklist
3837

3938
- [ ] 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.
4140
- [ ] For every major code block, provide a clear explanation of what it does and why it matters.
4241
- [ ] Structure content for quick scanning with clear headings and bullet points
4342

@@ -166,5 +165,4 @@ The exported HTML files will be automatically deployed to GitHub Pages through t
166165
# Push your changes to your fork
167166
git push origin feature/your-feature-name
168167
# Then go to GitHub and click "Create Pull Request"
169-
```
170-
168+
```

0 commit comments

Comments
 (0)