Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

integrity check and follow up actions #11419

Open
ilippert opened this issue Jun 23, 2024 · 8 comments · May be fixed by #12495
Open

integrity check and follow up actions #11419

ilippert opened this issue Jun 23, 2024 · 8 comments · May be fixed by #12495
Assignees
Labels
📍 Assigned Assigned by assign-issue-action (or manually assigned) component: integrity-checker

Comments

@ilippert
Copy link
Contributor

Is your suggestion for improvement related to a problem? Please describe.
I like the integrity check. I am frustrated that I cannot find wizards that help me to solve the errors found.

Describe the solution you'd like
I would like to select a finding/warning (or several at once) and then use a right click to select a possible action. E.g. for a file name with an ? offer to repair that, of for a Warning about a latex command (e.g. \enquote) I could "register" the command so that it does not generate a warning anymore.

@HoussemNasri
Copy link
Member

HoussemNasri commented Oct 14, 2024

Additional fixable finding/warning/reports can include:

  • Citation key deviates from generated key --> generate citation key for that entry
  • Capital letters are not masked using curly brackets {} --> Basic string manipulation

We can go with the right click approach or an approach similar to the image below or a combination or both: right-click when multiple possible fixes, and single-click when one possible fix (common case).

Image

Random thoughts

  • Applied fixes should be transparent to users. This means users should be informed about the previous inconsistent value of a field and the new consistent value that will be applied as a fix, possibly showing a difference (diff).
  • Sometimes multiple fixes are possible (.e.g. non-ASCII encoded character found), here we can delete all non-ascii characters, enclosing them in braces, or other actions. The UI should offer multiple choices of fixes when available.
  • While not directly related to this feature, integrity checks can sometimes be ignorable. For instance, if I intentionally use non-ASCII characters in a field, I wouldn't want it flagged as inconsistent every time I scan. There should be a column to mark integrity checks as ignored.

@priyanshu16095
Copy link
Contributor

/assign-me

@github-actions github-actions bot added the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Feb 11, 2025
Copy link
Contributor

👋 Hey @priyanshu16095, thank you for your interest in this issue! 🎉

We're excited to have you on board. Start by exploring our Contributing guidelines, and don't forget to check out our workspace setup guidelines to get started smoothly.

In case you encounter failing tests during development, please check our developer FAQs!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on JabRef's Gitter chat. And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.

Happy coding! 🚀

⏳ Please note, you will be automatically unassigned if the issue isn't closed within 90 days (by 12 May 2025). A maintainer can also add the "📌 Pinned"" label to prevent automatic unassignment.

@HoussemNasri
Copy link
Member

Hello @priyanshu16095, you currently have four assigned issues. Please ensure those are completed or unassigned before taking on additional tasks.

@HoussemNasri HoussemNasri removed the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Feb 11, 2025
@priyanshu16095
Copy link
Contributor

Apologies for this; I was not aware of it, but I have started working on this one and have also made some progress on the others.

Should I unassign myself from one of them to work on this?

@HoussemNasri
Copy link
Member

Yes, choose one to work on, and unassign yourself from all the other ones.

@priyanshu16095
Copy link
Contributor

priyanshu16095 commented Feb 11, 2025

@HoussemNasri I have unassigned myself from all the assigned issues.

May I continue working on this now?

@HoussemNasri HoussemNasri self-assigned this Feb 11, 2025
@HoussemNasri HoussemNasri moved this from Free to take to Assigned in Candidates for University Projects Feb 11, 2025
@HoussemNasri HoussemNasri added the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Feb 11, 2025
@koppor koppor moved this from Assigned to Free to take in Candidates for University Projects Feb 11, 2025
@priyanshu16095
Copy link
Contributor

Thank you for assigning me this issue!

@priyanshu16095 priyanshu16095 linked a pull request Feb 12, 2025 that will close this issue
7 tasks
@ThiloteE ThiloteE moved this from Free to take to Assigned in Candidates for University Projects Feb 25, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
📍 Assigned Assigned by assign-issue-action (or manually assigned) component: integrity-checker
Projects
Status: Assigned
Status: Normal priority
Development

Successfully merging a pull request may close this issue.

5 participants