nf-core / nf-core/tools

Depreciate & remove `mimetype`

Open
#2,527 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

schema
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

I don't think that mimetype is used by any tooling, and it generally confuses people about what to enter for it and what it will be used for.

The initial idea was that it could help 3rd party tooling for having generators - eg. if the mimetype is text/csv then a spreadsheet editor could be displayed for creating data. If it was text/json then a code editor and so on. However, in practice it's easy and arguably more robust to do this by using filename extension, plus no-one has added editor support anywhere (that I'm aware of).

As such, in order to keep the schema lean and not confuse people, proposal is to drop the field.

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.

Research direction

Search the repository for mimetype to identify its schema definition and every tooling reference. Remove the field from the schema and update the affected checks or documentation, then run the relevant test suite to confirm the schema remains valid and no supported tooling still depends on it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.