wavemaker / wavemaker/docs

Evaluate and add linting to detect at pull request issues in the change

Open
#45 1 comment 0 reactions 1 assignee View on GitHub

@sharathpc is already working on this.

Since Dec 6, 2019.

Dominant language
JavaScript
Stars
28
Forks
70
PR merge metrics
No merged PRs in 30d

Description

When contributor submits a pull request, we should automatically detect using linting potential issues with the change. The potential issues could be:

  1. Linking to an image with incorrect path
  2. Missing link, perhaps they forgot to specify the target hyperlink
  3. When page is missing a mention of sidebar id
  4. Has code but has not surrounded the code with back ticks. For example: /learn/request-response-processing-rest-services.md
  5. Has HTML code that is not fenced properly leading it to be executed by browser causing nasty issues like #97

check this remark-lint

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.