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

Collect student feedback #768

Merged
merged 30 commits into from
Apr 16, 2024
Merged

Conversation

rgu0114
Copy link
Contributor

@rgu0114 rgu0114 commented Nov 1, 2023

Summary

  • provide a means for students to give feedback on the TA who just finished helping them
  • prompt students with a feedback modal that pops up after the TA marks their question as done
  • enable both numeric star feedback and qualitative feedback the student writes
  • create Firebase functions to save this feedback object into the course document
  • feedback object stores OH session, question ID, rating, and written feedback

Demo of what the entire process looks like, with the prompt appearing properly and the student's input appearing in Firestore

Screen.Recording.2023-11-29.at.10.49.27.AM.mov

Below, we have a rudimentary version of what the feedback modal will look like

Screen Shot 2023-11-15 at 12 59 45 AM

Documentation

included in this PR as specification comments

Test Plan

  • open two terminals, one as a TA and the other as a student, and see that the feedback modal properly appears when question is marked as done
  • check that the feedback data properly appears on the Firebase console with the associated course

Notes

The styling in this PR is definitely a work in progress. Substitutions for the star rating in MUI's icon library that look more similar to the design or just larger in general weren't found, but will keep looking for other ways.

Will need to discuss form validation – e.g. whether or not we're able to submit incomplete feedback and the associated warnings that may pop up if we don't have sufficient feedback given.

Also note that this is a New PR for this ticket without all the annoying linting issues from this PR

Breaking Changes

None

  • I have updated the documentation accordingly.
  • My PR adds a @ts-ignore

@rgu0114 rgu0114 requested a review from a team as a code owner November 1, 2023 16:56
@dti-github-bot
Copy link
Member

dti-github-bot commented Nov 1, 2023

[diff-counting] Significant lines: 250.

Copy link
Contributor

@Sydney-tran Sydney-tran left a comment

Choose a reason for hiding this comment

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

This PR looks really good so far! I think the feedback form will be very helpful for professors/tas. In terms of validation, I think students should be required to add a somewhat detailed explanation (one or two words shouldn't be enough) so maybe the code could enforce a minimum character/word count, but this can definitely be discussed more with everyone at standup. Also, once you finish up the styling and the PR as a whole, don't forget to remove the console.log statements. Besides that, very nice job!

@rgu0114 rgu0114 changed the title [DRAFT]: New collect feedback Collect student feedback Nov 29, 2023
Copy link
Contributor

@burninglilies burninglilies left a comment

Choose a reason for hiding this comment

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

Great work so far! I don't see any bugs on my end when I run and test it for edge cases as well so far so the front end works perfect. But one thing to note is that the feedback is stored in courses and only the feedback rating and written feedback is stored. Sometimes there are multiple TA's that are assigned to a an office hours session and multiple sessions in a course so I think it would be beneficial to store the data on the student making the feedback and the TA receiving the feedback. And then maybe storing this in sessions instead of courses or as an alternative to this, store the session of the feedback in courses with the other information

@stevenyuser stevenyuser mentioned this pull request Mar 1, 2024
2 tasks
@stevenyuser stevenyuser self-requested a review March 30, 2024 05:34
Copy link
Contributor

@stevenyuser stevenyuser left a comment

Choose a reason for hiding this comment

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

This feature looks really good! I think the design looks pretty good and I tested it on my machine with two different accounts and it works. I also think it's a pretty useful feature for TAs, Professors, and students.

I have three possible suggestions about changing the functionality of the "Submit Rating" button.

  1. The button is clickable even when the conditions for valid feedback aren't fulfilled. Although this is visually shown to the user through the use of a grayed-out color for the button, the button isn't actually disabled. I recommend adding a disabled property to the button to fix this.
  2. The logic for valid feedback is repeated and should probably be in its own function or state variable. This way, it will be easier to call the logic for if feedback is valid and it will also be easier to add more complex logic to see if feedback is valid.
  3. Currently, feedback is only accepted if there is a rating and there's some text in the feedback box (length > 0). However, some students will probably only give a star rating to a TA and not write anything. I think that feedback should also be accepted, as it will probably be one of the most common forms of feedback.

src/components/includes/FeedbackPrompt.tsx Show resolved Hide resolved
Copy link
Contributor

@burninglilies burninglilies left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes Richard! I remember Alisha and Benji were the ones who suggested making comments on a review required to help collect extra feedback as justification to a star review. But we can leave it optional for now because of convenience purposes.
Also, I tested for the same things as my original review and it looks good as well.

@rgu0114 rgu0114 merged commit 4be4046 into master Apr 16, 2024
4 checks passed
@rgu0114 rgu0114 deleted the richardgu/answered-question-feedback branch April 16, 2024 20:08
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.

5 participants