readme, contributing: rewrite and reorganize contribution resources #2017
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…to update-readme
lilin90
changed the title
lilin90
changed the title
lilin90
changed the title
12 tasks
1 task
This was referenced Feb 28, 2020
1 task
ran-huang
reviewed
Mar 5, 2020
| | 5 | [MD023 - Headings must start at the beginning of the line](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md023---headings-must-start-at-the-beginning-of-the-line) | 标题必须出现在一行行首，即标题的 `#` 号前不能有任何空格。 | | ||
| | 6 | [MD026 - Trailing punctuation in heading](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-heading) | 标题末尾仅能出现中英文问号、反引号、中英文单双引号等符号。其余如**冒号**、逗号、句号、感叹号等符号均不能在标题末尾使用。 | | ||
| | 7 | [MD022 - Headings should be surrounded by blank lines](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md022---headings-should-be-surrounded-by-blank-lines) | 标题上下均须空一行。 | | ||
| | 8 | [MD024 - Multiple headings with the same content](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024---multiple-headings-with-the-same-content) | 文档中不能连续出现内容重复的标题，如一级标题为 `# TiDB 架构`，紧接着的二级标题就不能是 `# TiDB 架构`。如果不是连续的标题，则标题内容可重复。 | |
There was a problem hiding this comment.
Is this a typo? 😀
Suggested change
| | 8 | [MD024 - Multiple headings with the same content](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024---multiple-headings-with-the-same-content) | 文档中不能连续出现内容重复的标题，如一级标题为 `# TiDB 架构`，紧接着的二级标题就不能是 `# TiDB 架构`。如果不是连续的标题，则标题内容可重复。 | | |
| | 8 | [MD024 - Multiple headings with the same content](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md024---multiple-headings-with-the-same-content) | 文档中不能连续出现内容重复的标题，如一级标题为 `# TiDB 架构`，紧接着的二级标题就不能是 `## TiDB 架构`。如果不是连续的标题，则标题内容可重复。 | |
There was a problem hiding this comment.
@ran-huang Yes. Good catch! Would you please help fix this typo in all versions? (including release-2.0 & release-1.0)
There was a problem hiding this comment.
Sure, I'll fix this later~
ran-huang
reviewed
Mar 5, 2020
lilin90
added
the
requires-followup
This was referenced Mar 9, 2020
This was referenced Mar 10, 2020
lilin90
removed
the
requires-followup
lilin90
added
translation/done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted?
README.mdto make it more like a docs readme (replace simply intro to TiDB)CONTRIBUTING.mdupdatesREADME.mdandCONTRIBUTING.mdWhat is the related PR or file link(s)?
N/A
Which version does your change affect?
N/A