First off, thank you for considering contributing! This guide was built by students, for students. Your experiences, tips, templates, and even your horror stories can help someone else survive their project journey.
Small fixes are always welcome!
- Fork the repository.
- Make your changes.
- Open a Pull Request with a clear description of the fix.
We're always looking for:
| What | How to Contribute |
|---|---|
| New Tips or Hacks | Add to an existing page or create a new section. |
| Project Ideas | Add to docs/resources/project-ideas.md. |
| Templates (SRS, Reports, PPT) | Add links to docs/resources/templates.md. |
| Student Confessions | Open an issue with the confession label or add to docs/resources/confessions.md (anonymous is fine!). |
| Seminar Topic Ideas | Add to docs/seminar/topic-selection.md. |
- Use a conversational tone. We're talking to students, not at them.
- Include real examples. "Don't do X" is weaker than "I once saw a team do X, and this happened..."
- Keep it practical. Advice should be actionable, not generic.
# Clone your fork
git clone https://github.com/YOUR_USERNAME/CSE-College-Project-Roadmap.git
cd CSE-College-Project-Roadmap
# Install MkDocs and plugins
pip install -r requirements.txt
# Start the development server
mkdocs serveVisit http://127.0.0.1:8000 to see your changes live.
Before submitting, please ensure:
- Your content is clear and well-formatted (Markdown).
- You've checked for typos and grammatical errors.
- Any new pages are added to the
navsection inmkdocs.yml. - Your advice is based on real experience (or clearly marked as hypothetical).
No problem! Open an Issue and describe your idea. Someone else might pick it up.
If this roadmap helped you even a little bit, consider giving it a star on GitHub. It helps more students find it.
Thank you for being part of this community. 🎉