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

Shorten error messages #5546

Merged
merged 8 commits into from
Jun 13, 2024
Merged

Shorten error messages #5546

merged 8 commits into from
Jun 13, 2024

Conversation

ArtV11
Copy link
Collaborator

@ArtV11 ArtV11 commented May 21, 2024

This pull request is part of a larger project in which we are redesigning our error messages according to these guidelines.

In this PR, I have worked on the redesigning topic (iii) Keeping Them Short where we aim to keep our error messages concise and short while providing sufficient information about the issue and its cause. Given that people often do not read the entire error message, critical information will be presented at the beginning.

Addresses #5012

FKEFFIEENFIENFFI
@ArtV11 ArtV11 marked this pull request as ready for review May 21, 2024 13:18
Rtune11 and others added 4 commits May 28, 2024 06:36
I tried to shorten them by using the requirements of Clarity and brevity requirements which are (aesthetic and minimalist design, recognition rather than recall). Meaning the errors should be shortened because students tend to not read the whole error so it should give out the critical info at the first part, that way a student can understand what it is going to say by not fully reading the whole sentence.
@Felienne Felienne changed the title Draft Errors Shorten error messages Jun 11, 2024
@Felienne
Copy link
Member

Hi @jpelay!

One of the Cypress tests is failing on this one, could you take a look?

@jpelay
Copy link
Member

jpelay commented Jun 11, 2024

One of the Cypress tests is failing on this one, could you take a look?

It's failing because the test is expecting the old error messages. I will update it and they should be ok!

Copy link
Member

@Felienne Felienne left a comment

Choose a reason for hiding this comment

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

Let's go, thanks for the hard work!

Copy link
Contributor

mergify bot commented Jun 13, 2024

Thank you for contributing! Your pull request is now going on the merge train (choo choo! Do not click update from main anymore, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit a71d3a5 into main Jun 13, 2024
12 checks passed
@mergify mergify bot deleted the Artun-test-branch branch June 13, 2024 10:00
Copy link
Contributor

mergify bot commented Jun 13, 2024

Thank you for contributing! Your pull request is now going on the merge train (choo choo! Do not click update from main anymore, and be sure to allow changes to be pushed to your fork).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants