Contributing to English Project
Help make English learning accessible for everyone by contributing your knowledge and expertise
Quick Start Guide
Content Guidelines
Lesson Structure
Every lesson should follow this basic structure:
---
title: "Your Lesson Title"
description: "Brief description of what learners will gain"
category: "grammar" | "vocabulary" | "speaking" | "listening" | "writing" | "reading" | "pronunciation" | "culture"
level: "beginner" | "intermediate" | "advanced"
tags: ["tag1", "tag2", "tag3"]
author: "Your Name"
readingTime: 10
featured: false
publishDate: 2024-06-10
---
# Your Lesson Title
Introduction paragraph explaining the topic...
## Main Content Sections
### Subsection 1
Content with examples...
### Subsection 2
More content...
## Practice Exercises
Interactive elements for learners...
## Key Takeaways
Summary of main points...
Content Categories
Grammar
Tenses, sentence structure, parts of speech, punctuation
Vocabulary
Word lists, definitions, synonyms, collocations
Speaking
Pronunciation, conversation skills, speaking exercises
Listening
Comprehension exercises, listening strategies
Writing
Essays, emails, creative writing, structure
Reading
Comprehension, strategies, text analysis
Pronunciation
Phonetics, stress patterns, intonation
Culture
Idioms, cultural context, social language
Skill Levels
Beginner
- Basic vocabulary (1000-2000 words)
- Simple present tense
- Elementary grammar structures
- Common phrases and expressions
Intermediate
- Expanded vocabulary (3000-5000 words)
- Multiple tenses and modal verbs
- Complex sentence structures
- Professional and academic contexts
Advanced
- Sophisticated vocabulary (5000+ words)
- Complex grammar and nuances
- Idiomatic expressions
- Cultural subtleties
Special Components
Use these special MDX components to enhance your lessons:
Example Box
<div class="example-box">
Your examples here...
</div>Vocabulary Box
<div class="vocabulary-box">
**Word:** Definition
</div>Tip Box
<div class="tip-box">
**Pro Tip:** Your helpful tip here
</div>Exercise Box
<div class="exercise-box">
**Exercise:** Complete the sentences...
</div>File Organization
Where to Place Your Files
src/
content/
blog/
your-lesson-title.mdx ← Add your lesson here
public/
images/
lessons/
your-lesson-title/ ← Add lesson images here
image1.jpg
image2.pngNaming Conventions
- File names: Use kebab-case (lowercase with hyphens)
- Examples:
present-simple-tense.mdx,business-vocabulary.mdx - Images: Descriptive names related to content
- Folders: Match your lesson file name
Pull Request Process
1. Prepare Your Contribution
- Follow the lesson structure template
- Use appropriate category and level
- Include practical examples
- Add exercises or practice activities
- Proofread for grammar and clarity
2. Create Your Pull Request
- Write a clear title describing your lesson
- Provide a brief description of the content
- Mention any special features or components used
- Tag relevant maintainers if needed
3. Review Process
- Community members will review your contribution
- Respond to feedback and make requested changes
- Once approved, your lesson will be merged
- Your content is now live and helping learners!
Community Guidelines
Be Respectful
Treat all contributors and learners with respect and kindness.
Quality First
Focus on creating high-quality, accurate, and helpful content.
Inclusive Language
Use inclusive language that welcomes learners from all backgrounds.
Original Content
Ensure your contributions are original or properly attributed.