First off, thank you for considering contributing to PROMPT! It's people like you who make PROMPT such a great tool for project-based teaching.
If you remember nothing else from this guide, please keep these three rules in mind:
- 🧹 Leave It Cleaner Than You Found It: Every time you touch a piece of code, try to leave it in a better state. Tidy up as you go!
- 🔍 Do It Right the First Time: Aim for quality from the start. "Fixing it later" rarely happens, so let's avoid technical debt today.
- 🤓 Take Pride in Your Work: Write code that is a joy to read. Attention to detail is what differentiates good software from great software.
PROMPT is a modular platform with a React micro-frontend and Go microservices architecture. To get your development environment set up:
- Read the Technical Guide: Our AGENTS.md file is the source of truth for architecture, coding conventions, and common commands.
- Follow the Setup Guide: See our Detailed Setup Documentation for step-by-step instructions.
- Join the Community: We coordinate planning and support on our Discord Server.
- Check the Issues to see if the bug has already been reported.
- If not, use our Bug Report Template.
- We love new ideas! Please use our Feature Request Template to explain your vision.
- For large architectural changes, it's best to discuss them on Discord first.
- Branch Naming: Use descriptive names like
feature/your-featureorfix/your-bug. - Stay Focused: Keep PRs small and focused on a single change.
- Update Documentation: If you change functionality, please update the relevant files in the
docs/folder. - Follow Conventions: Adhere to the naming and structural conventions defined in AGENTS.md.
- Discord: Join our server for real-time discussion.
- Documentation: Visit our Documentation Portal.
By contributing, you agree to abide by our Code of Conduct.
Happy coding! 🚀