CSC/ECE 517 Fall 2020 - E2077. Mentor management for assignments without topics E2024: Difference between revisions
No edit summary |
|||
| Line 4: | Line 4: | ||
=== ''Objectives'' === | === ''Objectives'' === | ||
Implement code that will allow a mentor to be directly associated with a team. | |||
=== ''Previous Work'' === | |||
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution: | |||
*Code was merged from the previous team, but not refactored, so a lot of unused code remained. | *Code was merged from the previous team, but not refactored, so a lot of unused code remained. | ||
| Line 11: | Line 14: | ||
*Commented code should be removed. | *Commented code should be removed. | ||
*Some complex logic is added but not explained in the comments. | *Some complex logic is added but not explained in the comments. | ||
*Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class) | *Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class). | ||
* | *Documentation doesn't accurately represent implementation. | ||
* | *Lacked sufficient detail for Test section. | ||
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki] | |||
=== ''Possible Solutions'' === | === ''Possible Solutions'' === | ||
| Line 24: | Line 26: | ||
List all the files we changed when implementing our project | List all the files we changed when implementing our project | ||
== | ==References== | ||
Github Repository: <br> | |||
Pull Request: <br> | |||
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_E2024_Mentor_management_for_assignments_without_topics Previous Implementation's Wiki] | |||
==Team== | ==Team== | ||
Revision as of 15:02, 21 October 2020
Project Overview
Background
Currently, Expertiza has no way to associate mentors with teams. For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic, However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects.
Objectives
Implement code that will allow a mentor to be directly associated with a team.
Previous Work
We learned from previous implementations and looked to avoid the following pitfalls when implementing our solution:
- Code was merged from the previous team, but not refactored, so a lot of unused code remained.
- Should have followed a better naming convention for methods
- Some redundant codes in the views could be DRYed out.
- Commented code should be removed.
- Some complex logic is added but not explained in the comments.
- Code should be placed in most relevant classes. (E.g. Do not put email code in the Team class).
- Documentation doesn't accurately represent implementation.
- Lacked sufficient detail for Test section.
Previous Implementation's Wiki
Possible Solutions
Show the steps we are going to take in order to fix the problems
Files Modified
List all the files we changed when implementing our project
References
Github Repository:
Pull Request:
Previous Implementation's Wiki
Team
Santiago Sepulveda
Skieler Capezza
Liam Donovan
Javier Sanchez
Mentor: Yulin Zhang