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

Discussion: Removing feedback title or documenting its purpose #58

Open
FelixTJDietrich opened this issue Jul 24, 2023 · 0 comments
Open

Comments

@FelixTJDietrich
Copy link
Collaborator

FelixTJDietrich commented Jul 24, 2023

The feedback title is mostly unused, maybe we should remove it. Usually we generate a feedback description and the title is then derived from the kind of feedback:

I.e. for referenced feedback it is something like File ... at line x to y for programming exercises, but this could be derived from the reference fields. For unreferenced feedback it might always just be Feedback.

I guess it would make sense to have a title describing the feedback as kind of a summary:
I.e. Grammar mistake, Syntax error, Wording, Best practices, ...
But then we have to document this somehow that this is how the feedback title should be used and we have to fill it out properly.

References

@pal03377 should I also drop the feedback.title from the schema? We are not really using it 🤔

Let's discuss this separately from this PR

Originally posted by @pal03377 in #56 (comment)

@FelixTJDietrich FelixTJDietrich changed the title Removing feedback title Removing feedback title or documenting its purpose Jul 24, 2023
@FelixTJDietrich FelixTJDietrich changed the title Removing feedback title or documenting its purpose Discussion: Removing feedback title or documenting its purpose Jul 24, 2023
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

No branches or pull requests

1 participant