Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.03 KB
Raw

Contributing to Learn TypeScript

Thank you for your interest in improving this curriculum! We welcome contributions from developers of all skill levels.

How Can You Help?

1. Reporting Issues

If you find a typo, a bug in the code, or a confusing explanation, please open an Issue on GitHub. Be as specific as possible about the lesson number and the problem.

2. Suggesting Improvements

Have a better real-world example? Or a more challenging practice exercise? Open an issue to discuss your ideas!

3. Submitting Pull Requests

If you'd like to fix an issue or add a feature:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Ensure your code passes the type check: npm run check.
  4. Submit a Pull Request with a clear description of what you've changed.

Code Style

  • Follow the existing lesson template (Goal, Explanation, Examples, Challenges, Solutions).
  • Keep explanations concise (3-5 lines).
  • Use clear, descriptive variable names.
  • Ensure all samples are strictly typed.

Happy contributing! 🚀