Anduin2017 / Anduin2017/HowToCook

请添加代码提交前的校验功能(工具很多),别等到pr的时候再去做校验

Open
#756 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
102k
Forks
11.1k
Avg merge
14h 21m
Merged PRs (30d)
2

Description

提交的pr 有问题,但是肉眼很难看出来(主要是格式,与内容规则),所以需要在提交代码前借助CI 相关工具,提前验证,验证不通过不可以提交代码,而不是提交代码不验证,然后等pr 校验不通过过,再回来修改!另外把那个Ruby 的校验工具改成node 版本的吧,markdownlint-cli,这样方便做CI

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

Start by locating the repository's existing Ruby validation tool and current CI configuration. Compare the requested Node-based markdownlint-cli approach with the existing checks, then define the pre-commit validation scope; the work is done when formatting and content-rule failures are caught before submission.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, ruby
Domain
ci-cd, documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.