nf-core / nf-core/tools

Save SVG originals for logos to repo

Open
#3,582 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

Since the resulting png files for logos are sometimes generated differently and hence fail the files_unchanged tests in linting, add the original SVGs to pipeline repos and test those instead. See https://nfcore.slack.com/archives/CE5LG7WMB/p1747994485372089.

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

Start by locating the linting tests that exercise files_unchanged and the code handling logo files in pipeline repositories. Compare the current PNG-based checks with the requested original-SVG workflow. Done means original SVGs are stored in the repositories and the relevant tests validate those originals without generated-PNG differences causing failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.