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

Multiple entries: New validation warnings #1481

Open
FinnRG opened this issue May 31, 2023 · 8 comments
Open

Multiple entries: New validation warnings #1481

FinnRG opened this issue May 31, 2023 · 8 comments
Labels
adding/editing entries Adding/Editing entries (artists, songs, albums, tags, song lists, events) complexity: unknown Unknown days of work content: albums Album entries content: artists Artist entries content: songs Song entries feature request feedback-wanted Feedback and further discussion needed (open questions) frontend Presentation layer (visible to user) priority: low Issues/Tasks that are not so important warnings/pop-ups Validation warnings and other info pop-ups

Comments

@FinnRG
Copy link
Member

FinnRG commented May 31, 2023

Part of #1450. Validation warnings are a good way to prevent common editing errors. We should add new warnings and update outdated/unspecific warnings. This is especially important for events and tags, where we don't have any warnings.

Current issues regarding validation warnings:

Here are all of our current validation errors:

Songs

  • DuplicateArtist: The same artist cannot be added twice. Please remove the duplicate and edit the roles accordingly
  • NeedArtist: Song needs at least one artist.
  • NeedOriginal: Derived songs need to have an original version specified, if it's in the database, or the original needs to be mentioned in notes.
  • NeedProducer: Song should have at least one producer (composer, arranger or animator) role.
  • NeedReferences: Song needs notes, PVs or links for reference.
  • NeedType: Song type needs to be specified.
  • NonInstrumentalSongNeedsVocalists: This song has no vocalists. Original instrumental songs need to be tagged with the 'instrumental' tag. Instrumental (karaoke) versions of existing songs should use the 'Instrumental' song type. Otherwise, add vocalists.
  • RedundantEvent: The same release event does not need to be specified for both the song and album.
  • RedundantRoles: Producer's roles do not need to be specified when that producer is the only one.
  • UnspecifiedNames: Song needs a primary name.

Artists

  • NeedReferences: Artist needs a description OR at least one external link as a reference.
  • NeedType: Artist type needs to be specified.
  • UnnecessaryPName: There is no need to add artist name both with and without the P suffix.
  • UnspecifiedNames: Artist needs a primary name.

Albums

  • DuplicateArtist: The same artist cannot be added twice. Please remove the duplicate and edit the roles accordingly.
  • NeedArtist: Album needs at least one artist.
  • NeedCover: Album needs a cover.
  • NeedReferences: Album needs a description or links for reference.
  • NeedReleaseYear: Release year needs to be specified.
  • NeedTracks: Album needs a tracklist.
  • NeedType: Record type needs to be specified.
  • UnspecifiedNames: Album needs a primary name.
@FinnRG FinnRG added frontend Presentation layer (visible to user) feedback-wanted Feedback and further discussion needed (open questions) labels May 31, 2023
@Shiroizu
Copy link
Member

The current warning coverage is pretty extensive. There are a couple common edit mistakes that could be added as new validation warnings that I could think of:

Song length: PV lengths should match for the same song entry (withing 5s or so). There might me rare edge cases to this.

Ambiguous producer roles: When song entry includes multiple producers (composer/arranger/voice manipulator), and if for one of them the role is specified, the roles should be specified for all of them. All producer roles should be either on default (= not specified) or specified for all of them.

@Shiroizu
Copy link
Member

Album entries do no seem to warn about missing voice synths. I think that could be added too.

@FinnRG
Copy link
Member Author

FinnRG commented May 31, 2023

@Shiroizu What about tag and event entries? I don't think new users usually edit them, but maybe there are some common editing mistakes that I don't know of. There was also some discussion about restricting tag editing to trusted+ users, to prevent mistakes. Maybe entry warnings could help with that (I don't want to restrict standard users to much, because TouhouDb and UtaiteDb don't have large trusted user groups).

@FinnRG FinnRG moved this to TODO in Frontend overhaul Jun 4, 2023
@andreoda andreoda added the adding/editing entries Adding/Editing entries (artists, songs, albums, tags, song lists, events) label Jun 5, 2023
@FinnRG
Copy link
Member Author

FinnRG commented Jul 30, 2023

Mentioned by @andreoda on discord:

  1. New validation warning for venues in China.
  2. new validation warning for missing publish dates on songs

@saturclay
Copy link
Contributor

For the NonInstrumentalSongNeedsVocalists warning, I noticed (at least on TouhouDB) that this triggers even if you already tagged the song as instrumental--I'm not sure if that's a check that can easily be added, but I did find it confusing at first given that the warning explicitly says the tag is needed. Additionally, this warning doesn't really seem as applicable to TouhouDB, since, unlike VocaDB, there's not any particular reason why songs would need to have vocalists. Could/should this warning be removed for TouhouDB alone?

@andreoda andreoda added warnings/pop-ups Validation warnings and other info pop-ups complexity: unknown Unknown days of work labels Mar 6, 2024
@andreoda andreoda added the priority: low Issues/Tasks that are not so important label Mar 23, 2024
@andreoda andreoda added content: songs Song entries content: albums Album entries content: artists Artist entries moderation Moderator or trusted user actions/tasks and removed moderation Moderator or trusted user actions/tasks labels Nov 10, 2024
@andreoda
Copy link
Member

andreoda commented Nov 10, 2024

Events, venues, song lists and tags also need warnings.
Here are all data fields that can be empty when creating:

Events:

  • series number (default is 0, should be different than 0) (if part of event series)
  • original language (name)
  • description
  • category
  • date
  • setlist
  • venue entry (or venue name)
  • picture
  • external links
  • artists
  • media

Venues:

  • original language (name)
  • description
  • coordinates
  • country/region
  • address
  • external links

Songlists:

  • description
  • category
  • date
  • picture
  • songs

Tags:

  • original language (name)
  • category
  • parent
  • description
  • picture
  • related tags
  • valid for checkmarks (default is all, should be more that 0)
  • external links

depending on which data is required for these entry types, we should add warnings for those.

@mn7216
Copy link
Contributor

mn7216 commented Nov 11, 2024

Can we include a warning to include lyric sources? "This entry is missing a source for [English/Romanized/Original] lyrics."

@andreoda
Copy link
Member

andreoda commented Nov 18, 2024

Addition:
All warnings should be displayed on the entries before users enter the edit mode, I think.
Especially the warning about users editing an entry at the same time.

Context: here

@andreoda andreoda changed the title New validation warnings Multiple entries: New validation warnings Nov 21, 2024
@andreoda andreoda pinned this issue Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adding/editing entries Adding/Editing entries (artists, songs, albums, tags, song lists, events) complexity: unknown Unknown days of work content: albums Album entries content: artists Artist entries content: songs Song entries feature request feedback-wanted Feedback and further discussion needed (open questions) frontend Presentation layer (visible to user) priority: low Issues/Tasks that are not so important warnings/pop-ups Validation warnings and other info pop-ups
Projects
Status: TODO
Development

No branches or pull requests

5 participants