Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 1.25 KB

Contributing

Thanks for helping improve JavaScript Mastery.

Ways To Contribute

  • Fix typos / improve explanations
  • Add examples for existing topics
  • Add practice problems with solutions
  • Improve structure and navigation

Ground Rules

  • Keep explanations beginner-friendly and accurate
  • Prefer runnable examples (examples/) when possible
  • Avoid adding external dependencies unless there is a strong reason
  • Keep formatting consistent (Markdown headings, code fences with js)

Project Structure

  • docs/: topic notes
  • examples/: runnable Node examples

Local Setup

git clone https://github.com/ReactSphere/javascript-mastery.git
cd javascript-mastery
npm -v
node -v

Run examples:

npm run examples:arrays
npm run examples:functions
npm run examples:async

Creating A Change

  1. Create a branch: git checkout -b your-branch-name
  2. Make changes
  3. Ensure examples still run
  4. Open a Pull Request

Commit Message Style

Use short, descriptive commits.

  • docs: clarify closure example
  • examples: add map/filter demo
  • chore: improve README badges

Reporting Issues

Open an issue and include:

  • what you expected
  • what happened
  • steps to reproduce (if applicable)
  • screenshots/logs if helpful