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

feat(data-modeling): Create Assessment.Survey collection type #47

Merged
merged 1 commit into from
May 23, 2024

Conversation

ll-zerr
Copy link
Contributor

@ll-zerr ll-zerr commented May 15, 2024

Resolves #46

Creates Assessment.Survey collection type

Copy link
Collaborator

@jtfairbank jtfairbank left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: @ll-zerr great job! one quick suggestion, and you've inspired a larger architecture question as well. might be good to discuss that one when your squad gets together (tho do post the highlights from the discussion on here for the rest of us)

src/api/assessment/content-types/survey/schema.json Outdated Show resolved Hide resolved
"info": {
"singularName": "survey",
"pluralName": "surveys",
"displayName": "Assessment.Survey"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question(blocking): I initially thought "Assessment.Survey" was too broad in terms of naming, since we might have other types of Assessments in the future (Needs Assessment, Capacity Assessment, Interest Survey, etc). But then I realized that most of them would probably use a lot of the same underlying code to generate the surveys, and simply map to a different data types (Need, Capacity, etc). Would it make more sense to:

  1. Keep this broad and consolidate any of our assessment / survey code here?
  2. Make this thin (i.e. "NeedsAssessment.Survey" and use components to capture reusable code?
  3. Something in the middle.

@TravisAlmey @madcalf would love your input here as well!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My personal opinion would be to keep this relatively thin. I might rename this to NeedsAssessment and then when we do run into common functionality split out the needed functions into reusable code. I am of the opinion that splitting out things into reusable funtions should be done afterward unless you have other tasks on your roadmap that specifically would need the shared code.

I guess this is an extension of the YAGNI priciple: https://en.wikipedia.org/wiki/You_aren%27t_gonna_need_it

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TravisAlmey makes a lot of sense to me! @ll-zerr what do you think about this approach? So we'd have something like NeedsAssessment.Survey and NeedsAssessment.Need collection types in this module.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jtfairbank , I created a new api for the survey collection type to align with the naming suggested. It should be noted that all references to the previous api and the survey collection had to be removed from the modeling prior to creating the new api to avoid errors when updating the types.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ll-zerr looks great! Can you work with @Lovelyfin00 to make sure that process of "renaming" a collection type is documented for folks who might need to do it in the future? A section towards the bottom of the readme, or a markdown file in a /docs folder seem like a good place for it, but I'll defer to where @Lovelyfin00 thinks is best!

@jtfairbank
Copy link
Collaborator

Praise: @ll-zerr approved the PR!

Todo: There are some conflicts preventing me from merging. Can you rebase saga into this branch to resolve them? Lmk if you need help and we can do it together during one of the tech hangouts this week!

@ll-zerr ll-zerr force-pushed the feat/46/create-assessment-survey-type branch from 704eac2 to 9713e6c Compare May 23, 2024 16:21
@jtfairbank jtfairbank merged commit b71c6d3 into saga May 23, 2024
1 check passed
@jtfairbank jtfairbank deleted the feat/46/create-assessment-survey-type branch May 23, 2024 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feat(data-modeling): Create Assessment.Survey collection type
3 participants