graphprotocol / graphprotocol/docs

forbid starting `$` char in ```sh code blocks

Open
#350 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
85
Forks
162
Avg merge
6h 31m
Merged PRs (30d)
4

Description

sometimes we put, sometimes not - we can add lint rule to always avoid
image
image

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

No file or test is named in the issue. Start by locating the documentation lint configuration and any existing checks for sh code blocks; done means the lint rule consistently rejects blocks whose command lines start with $, with coverage for the reported formatting cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation, tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.