nf-core / nf-core/eager

Remove linebreaks in markdown docs to reduce diff size

Open
#617 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

DSL2 low_priority
Dominant language
Nextflow
Stars
215
Forks
91
Avg merge
5m
Merged PRs (30d)
1

Description

Cause that makes manual merges difficult

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 Markdown documentation files covered by this issue and inspect how their line breaks currently affect diffs and manual merges. Confirm the intended formatting convention before making changes. Done means the relevant Markdown docs have reduced unnecessary line breaks and produce smaller, easier-to-merge diffs.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.