mozilla / mozilla/grcov

gitlab template in `README.md` is wrong

Open
#1,344 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.4k
Forks
170
Avg merge
3d 10h
Merged PRs (30d)
4

Description

README.md contains https://github.com/mozilla/grcov/blob/2cbc55385c3a4d6239dddf56d44b908bb7d67191/README.md#L354-L374

Using - | is wrong; this would require \ at the end of the lines.

Just write

    - grcov
    # This path must match the setting in LLVM_PROFILE_FILE. If you're not getting the coverage
    # you expect, look for '.profraw' files in other directories.
        target/coverage

Contributor guide

No contributing guide indexed for this repository

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

Open README.md around lines 354–374 and inspect the GitLab coverage template. Confirm the YAML block's formatting against the issue description; it is done when the template uses the shown list and path structure without the incorrect block scalar syntax.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.