CSE Guide

Contribute to the Guide

Help make CS education more accessible for everyone.

Why contribute?

This guide exists to help CS students succeed, and it gets better with community input. Whether you're a beginner who found something confusing or an experienced developer with insights to share, your contributions make a real difference.

Ways to contribute

📝 Content improvements

  • Fix typos and grammar - Every correction helps
  • Clarify confusing sections - If you had to read something twice, others will too
  • Add examples - Real-world examples make concepts stick
  • Update outdated information - Tech moves fast, help us keep up

💡 New content

  • Share your experience - What worked for you? What didn't?
  • Add resource recommendations - Great tools, books, or courses you've found
  • Write new sections - Is there a topic we're missing?
  • Create exercises or projects - Hands-on practice ideas

🐛 Report issues

  • Broken links - The web changes, links die
  • Factual errors - Help us keep information accurate
  • Missing topics - What else should we cover?
  • Accessibility issues - Help us make the guide usable for everyone

How to contribute

Quick contributions (no coding required)

  1. Found an issue? Open an issue on GitHub
  2. Describe what you found and suggest an improvement
  3. We'll review and make the changes, crediting you

Direct contributions (for the Git-savvy)

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a branch for your changes
  4. Make your improvements to the markdown files
  5. Test locally (optional but appreciated)
  6. Submit a pull request with a clear description

Contribution guidelines

Content style

  • Keep it friendly - No academic jargon, write like you're helping a friend
  • Be practical - Focus on actionable advice over theory
  • Stay current - Prefer recent tools and practices
  • Be inclusive - Consider different backgrounds and learning styles

Technical requirements

  • Markdown format - All content is written in Markdown
  • Clear headings - Use proper heading hierarchy (H1, H2, H3)
  • Link check - Make sure all links work
  • Spell check - Basic proofreading goes a long way

Recognition

All contributors will be credited in the repository. Significant contributions may be highlighted in the guide itself. This is a community effort, and we want to celebrate everyone who helps make it better.

Questions?

Not sure about something? Want to discuss a major change before implementing it? Feel free to:

View Repository Report an Issue