apache / apache/hertzbeat

[Task] Optimize historical Markdown file format

Open
#2,574 15 comments 0 reactions 7 assignees Claimed by @yuluo-yx View on GitHub
good first issue help wanted task
Dominant language
Java
Stars
7.4k
Forks
1.3k
Avg merge
1d 20h
Merged PRs (30d)
32

Description

### Description

We have changed the Markdown formatting tool to Markdownlint, which can set rules more comprehensively. At the same time, some new tasks have been added. Setting rules will cause a lot of history files to be modified.

It is divided into the following tasks. If you are interested, you can claim them yourself.

![image](https://github.com/user-attachments/assets/d980c7eb-08f0-4571-8455-5ffd5b2ce172)

rule description : https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

|task|assignee|complete status|
|---|---|---|
|MD001|@tomsun28|✅|
|MD003|@Calvin979|✅|
|MD013|@tomsun28|✅||
|MD024|@zhangshenghang|✅|
|MD025|@Aias00|✅|
|MD029|@pwallk |✅|
|MD033|@Calvin979|✅|
|MD035|@zhangshenghang|✅|
|MD036|@yuluo-yx||
|MD040|@yuluo-yx|✅|
|MD041|@zhangshenghang|✅|
|MD045|@Calvin979|✅|
|MD046|@zhangshenghang|✅|
|MD047|@LiuTianyou|✅|
|MD052|@zhangshenghang||

### Task List

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.