This guide is meant to help project students and project supervisors to have sustainable academic contribution
There are few steps that we have to take after you agree on a project (brief/description) and before starting the project
- Create a new repository using the agreed project name and description (Please note: Do not start the name with 3rd year project).
- Use the MD guideline found here to formate your project page. To get help with managing your git repo use tutorial here.
- All project document must be written in Latex.
- For projects that require a test enviroment, please use vagrant to build your virtual machines. Feel free to use this cheatsheet.
- For projects that requires the development of REST API please use open api specification in Swagger.
- Supervisors and student must agree on a regural supervision time
- At each session the supervisor has to do two things A - Check his written notes for previous meeting objectives that the student has set for him/her self B - Help the student write new objectives for next week
- Triple check the project on git and make sure the tools work
- Ask for any tutorials that the student used to learn and document it for future student.