galaxyproject / galaxyproject/planemo

Recommended entry order when linting .shed.yml files

Open
#580 3 comments 0 reactions 0 assignees View on GitHub
enhancement linting
Dominant language
Python
Stars
110
Forks
102
Avg merge
4d 21h
Merged PRs (30d)
13

Description

Currently https://galaxy-iuc-standards.readthedocs.io/en/latest/best_practices/shed_yml.html does not specify a recommend order for the `.shed.yml` entries, but we have a convention in the order used for `tools-iuc` (assuming it is consistent).

Should `planemo shed_lint` enforce this (as it does for the Tool XML order)?

Contributor guide

Open the contributing guide

Research direction

Start with the linked shed_yml best-practices page and the existing planemo shed_lint behavior for Tool XML ordering. Compare the .shed.yml entry order used by tools-iuc, then determine the intended convention and whether it should be documented and enforced. Done means the expected order and enforcement scope are settled and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.