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

Additional code review features #1852

Closed
pdawyndt opened this issue Apr 14, 2020 · 2 comments
Closed

Additional code review features #1852

pdawyndt opened this issue Apr 14, 2020 · 2 comments
Labels
feature New feature or request

Comments

@pdawyndt
Copy link
Contributor

pdawyndt commented Apr 14, 2020

Some additional code review features related to annotations:

  • press escape to cancel editing of an annotation (DONE)
  • support LaTeX-style formulas in annotations ($...$, $$...$$, [...]) Support LaTeX-style formulas in annotations #2049
  • remove all text should result in removal of the annotation itself (now user is prevented to do some actions)
  • separate global annotations that appear above the code from global annotations that appear below the code
  • move annotation to another line (drag-and-drop)
  • reorder annotations attached to the same line (drag-and-drop)
  • show/hide annotations when clicked on the circle in the left margin (always show circles, Show specific code-annotation when annotations are minimized #2037)
  • duplicate annotations on same code (or link multiple sections to the same annotation)
  • reuse annotations attached to other submissions (annotations could be scoped, such that one could e.g. easily retrieve previous annotations attached to lines of the same function)
  • migrate annotations to next version of code (later submission by same user for same exercise)
  • link annotation to sequence of lines (instead of individual line)
  • link annotation selection (not necessarily an entire line or a sequence of lines)
  • link annotation to multiple selections (e.g. if it applies to multiple sections in the code)
  • support simple strikethrough (for a given selection) as a special type of annotation (possibly in combination with some text)
  • anonymous annotations (students don't see name of reviewer; e.g. they see a rubber duck instead)
  • option to manually hide/show annotations (only for annotations not linked to a review session)
  • offline reviewing: local copy of code-under-review, review in editor/IDE, upload annotations
  • allow students to ask questions about their code by
    • asking for a "request review"
    • allowing self-annotations
    • some teachers might also prefer to disable these options for their courses
  • allow replies to annotations (turning them into discussion threads)
  • like an annotation
    • allow course admins to flag student question as answered, so that notification about the question disappears for other course admins
    • allow students to flag annotation as resolved (either as a reminder to self that an issue has been fixed or to indicate that a reply has been helpful)
  • assign submission to course admin/course user for review
  • peer review (bulk assignment of submissions to course users for review)
  • provide way to quickly go to previous/next annotation (short key)
  • editor for formatting annotations in Markdown
    • style as code fragment (in the programming language of the submission) would be a handy feature
  • translate annotation to another language (e.g. using the Google Translate API); could be done statically by the reviewernd/or dynamically by the submittor reading the review
  • lengthy annotations can be displayed in abbreviated form, with toggle to show more/less (see Google Doc annotations)
  • what I like about making annotations in Google Doc is that you can select a code fragment and then add an annotation to it using the short key Ctrl+Alt+M
  • track if students have seen all annotations; probably this is functionality that is both needed to show notifications and would also be interesting for course admin to see how many students have actually looked at the feedback
  • add annotations to course statistics
    • number of annotations (visible, hidden)
    • number of questions from students (open, in progress, closed)
@chvp chvp added the feature New feature or request label Apr 14, 2020
@chvp chvp modified the milestones: later, untriaged Apr 14, 2020
@pdawyndt
Copy link
Contributor Author

pdawyndt commented May 1, 2020

Notifications

@BTWS2
Copy link
Contributor

BTWS2 commented Sep 7, 2020

While commenting an GitHub I found that GitHub now has a feature to comment on multiple lines by dragging the +-icon. Similar UX can be used for adding a comment in Dodona.

image

@chvp chvp removed this from the untriaged milestone Apr 12, 2021
@chvp chvp closed this as completed Jun 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants