How to Contribute to the Everyone-Can-Use-English Project: Complete Guide for Contributors

Fork the repository, edit Markdown files in the appropriate section (1000-hours/, book/, or enjoy/), and submit a pull request against main.

The everyone-can-use-english project by ZuodaoTech is a community-driven collection of English-learning materials built entirely from plain-text Markdown files. The repository's intentionally simple architecture allows contributors of any technical background to add lessons, improve existing content, or reorganize materials without navigating complex build pipelines.

How the Repository Is Structured

Understanding the layout helps you place contributions in the right location. The project organizes content into four distinct areas:

Area	Purpose	Key Entry Points
Core curriculum	The "1000-Hours" systematic learning pathway with phonetics drills and brain-science essays	1000-hours/README.md, book/chapter1.md through chapter8.md
Supplementary book	Free-form ebook chapters covering GRE writing, TOEFL listening, and general tactics	book/README.md, book/chapter1.md
Enjoy-App	Interactive companion tools for audio generation and AI-assisted conversation practice	enjoy/README.md
Drafts & notes	Working documents showing how new material is organized	new-edition-drafts/第一轮讲解/00-启动任务.md

The top-level README.md contains the mission statement and quick-start instructions for new contributors.

Step-by-Step Contribution Workflow

1. Fork and Clone the Repository

Start by creating your own copy of the project:

git clone https://github.com/<your-username>/everyone-can-use-english.git
cd everyone-can-use-english

2. Create a Feature Branch

Isolate your changes in a dedicated branch with a descriptive name:

git checkout -b feature/add-chapter-5

3. Edit or Add Markdown Content

Modify existing files or create new ones following these conventions:

• Match the formatting style in book/chapter1.md (headings, code blocks, bullet lists)
• Place new assets (audio, images) in logical subdirectories like 1000-hours/sounds-of-american-english/
• Start each file with a level-1 (#) title that mirrors the filename

4. Preview Your Changes Locally

The project requires no compilation. Open Markdown files directly in VS Code or any Markdown previewer. For the Enjoy-App components, consult enjoy/README.md for dependency and installation details.

5. Commit with Clear Messages

git add .
git commit -m "Add Chapter 5: Advanced Listening Strategies"

Keep commit messages in English only — the project's audience is English learners worldwide.

6. Submit Your Pull Request

Push your branch and open a PR against the upstream main branch:

git push origin feature/add-chapter-5

Fill out the default GitHub PR template, including:

• Short description of changes
• Related issue numbers (if applicable)
• Completion checklist

7. Address Review Feedback

Maintainers may request wording adjustments, source citations, or structural changes. Update your branch and push — the PR refreshes automatically.

Contribution Best Practices

Follow these guidelines to ensure your everyone-can-use-english contributions merge smoothly:

• Stay consistent with structure — new lessons belong under book/, 1000-hours/, or enjoy/ based on content type
• Cite authoritative sources — add footnote-style links to academic papers, pronunciation guides, or established references
• Avoid large binary files — link to external hosting for audio; provide short samples in-repo only when essential
• Write descriptive headings — mirror filenames in your level-1 titles for predictable navigation
• Use English throughout — commit messages, PR descriptions, and inline comments should all be in English

Quick Reference Checklist

• Fork the ZuodaoTech/everyone-can-use-english repository
• Clone your fork locally
• Create a dedicated feature branch
• Add or modify Markdown content following existing style
• (Optional) Test Enjoy-App components per enjoy/README.md
• Commit with descriptive English messages
• Push branch and open PR against main
• Respond to reviewer feedback promptly

Summary

Contributing to everyone-can-use-english requires only basic Git skills and Markdown familiarity. The repository's flat structure removes technical barriers, letting educators and learners focus on content quality. Key takeaways:

• Fork, branch, edit Markdown, and PR — no build steps required
• Place content in 1000-hours/, book/, or enjoy/ based on purpose
• Follow existing formatting in book/chapter1.md for consistency
• Keep all project communication in English
• Document sources with footnote-style references

Frequently Asked Questions

Do I need programming experience to contribute to everyone-can-use-english?

No. The repository contains only Markdown text files. You can edit lessons directly in GitHub's web interface or any text editor without installing development tools. The Enjoy-App section involves optional scripts, but curriculum contributions require no coding.

What types of content does the project need most?

The core curriculum (1000-hours/) welcomes additional phonetics drills, listening exercises, and brain-science research summaries. The supplementary book (book/) accepts essays on test preparation (GRE, TOEFL, IELTS) and practical language tactics. Check new-edition-drafts/ for planned topics.

How should I format academic citations in my contributions?

Use footnote-style markdown links to authoritative sources. Place full references at the bottom of your file, numbered sequentially. Follow the pattern established in existing book/ chapters: brief in-text mention, then expanded citation in a "References" section.

Can I contribute audio or video materials directly?

Avoid committing large binary files to keep the repository lightweight. Host media externally (SoundCloud, YouTube, or dedicated file hosting) and embed links with brief descriptions. Include short text transcripts in the Markdown file for accessibility and searchability.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}