Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Design code for metric categories #23

Open
4 tasks done
tap5136 opened this issue Nov 8, 2022 · 0 comments
Open
4 tasks done

Design code for metric categories #23

tap5136 opened this issue Nov 8, 2022 · 0 comments
Assignees

Comments

@tap5136
Copy link
Collaborator

tap5136 commented Nov 8, 2022

Description:

The metrics list has been broken into individual categories. 4 of them to be exact: Complexity, Keywords, Coupling, and Size. For the sake of evolvability and development, it'd be nice to have a class design for this. This would likely include an abstract class/interface and plans for each of the 4 classes. OOP principles should be followed, function names and documentation would also be nice, UML required. Skeleton file wouldn't be a bad idea (NO ACTUAL CODING).

If skeleton files are added, we should see what the commit history looks like to know how big our commits should be. Wouldn't hurt to know this in general tbh.

Related Epic:

Metrics Backend

Number Of Story Points: 2

Acceptance Criteria:

  • Done when UML is finished for the metrics categories code
  • Done when a list of functions and their purposes is written out.
  • Done when this documentation is provided in the Drive
  • If Skeleton files deemed necessary, done when a PR is made with those skeleton files in the repository.

Comments

  • Pointed at a 2 on 11/8
@pch3549 pch3549 moved this from Work For This Sprint to Done in AntiCopyPaster Senior Project 22-23 Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants