Autogenerate README
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Nextflow
- Stars
- 23
- Forks
- 6
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 6
Description
Description of feature
It would be nice to generate and publish a README file (or append if one is there already) to explain what files are there and how they were created
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by inspecting the repository's existing pipeline and README handling, then determine where generation and publication belong. Done means a README is generated or appended and explains which files are present and how they were created, but the issue does not define the publishing mechanism or exact content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100