OpenEnergyPlatform / OpenEnergyPlatform/omi

More Error messages needed

Open
#103 4 comments 0 reactions 2 assignees View on GitHub

@henhuy is already working on this.

Since May 28, 2024.

OMI rewrite part: backend :bricks: priority: low :sloth: status: blocked :stop_sign:
Dominant language
Python
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

OMI can benefit from useful error messages.

For example:

  • File doesn't match metadata description
    • column doesn't exist / has different data type / has different name
    • table has more columns than described in metadata
  • JSON seems to be invalid at location X
  • key name does not exist in standards, typo?
  • Warning: no license has been chosen, this field will be necessary when uploading to the OEP

I would recommend creating a list of possible errors first and to then write useful messages and tests for them.

Also, maybe have a look a the license check performed on OEP (implemented by @jh-RLI ) and if it makes sense to put it into OMI or leave it there.

See #99

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.