galaxyproject / galaxyproject/planemo

Implement a .shed.yml 2 README.md command.

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

Description

- Use description and long_description to assemble the core of the README.md.
- Use repository url to build lists of tools and links in Markdown.
- Optionally add some basic usage information based on all of this (how to clone, test, serve, update, etc...).

Consider a few more .shed.yml fields to enhance both README and shed recording - such as license information, contributing, etc....

Contributor guide

Open the contributing guide

Research direction

Start by locating the command that processes .shed.yml and the existing README.md generation path. Trace how description, long_description, and repository URL are currently represented, then review related command tests if present. Done means the command assembles the requested Markdown content and handles the proposed optional fields without breaking existing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.