COMP426 final project template repository. All your code and documentation goes here. Change this text to be a brief description of your final project. Put the name in the header above. You will change everything below to be the main technical documentation, as outlined below.
Other steps that you will need to take after you have cloned this repository:
- Choose and update the LICENSE file accordingly.
- Edit this README.md file and use it as the main location of your technical documentation with links out to information contained under
/docs/
. - Create a
/docs/
directory for more elaborate documentation of your API, planning notes, etc. - Make sure that all of your team members have access to the repository as administrators.
- Create a project under the Projects tab. Use this to manage your planning. Create a To-do list, etc. Explore the tools available and user them to manage your project.
- Assign team roles and include a listing of those roles in this README.md file or in another file under
/docs/
. - Then put your entire development workflow in this repository.
- Use Pull requests to propose changes and incorporate them into your code from various team members.
- Use Issues to identify and track bugs and also to communicate about various aspects of the project.
Plan to meet with your team ASAP. Talk through identifying roles within your team.
Try to figure out what each of you are good at/enjoy doing and try to work out roles that incorporate that.
Some basic roles you will want to consider:
- A review manager - someone to review pull requests and merge or reject them and manage the related discussions
- A plan manager - someone to keep an eye on the overall plan and keep the project tab/to-do list up to date
- A documentation manager - someone to keep the documentation in order and identify what is missing and needs to be documented
- Roles for team members to take charge or different parts of the project. Possible roles:
- Front end lead
- Back end lead
- Databse lead
- Design lead
- Etc.
You will notice that there are more roles than people in your group. That is because you will all be doing a hybrid job of managing a thing while working on other things.
Once all the groups are together, we'll assign each group to an LA to check in with as you progress through the project.
We will post that so that your team can schedule a time for an initial check-in with your assigned LA. It would be a good idea also to add your LA to your repository.
And that is about all you need to get started.
All the rest of the assignment instructions are available at: https://comp426.johndmart.in/assignments/99
Good skill, and have fun with this!