LinuxSuRen / open-source-best-practice

This is an open-source best practice for those who want to participate in open-source projects 参与开源过程中的一些最佳实践
https://linuxsuren.github.io/open-source-best-practice/
MIT License
382 stars 32 forks source link

Docs: Format document #155

Open yuluo-yx opened 10 months ago

yuluo-yx commented 10 months ago

now, in https://linuxsuren.github.io/open-source-best-practice/.

There are some problems with mixing Chinese and English and formatting problems

e.g.:

The number of spaces before and after them should be consistent.

image

There are some punctuation issues:

image
LinuxSuRen commented 10 months ago

hi @yuluo-yx , thanks for reporting this issue. Please feel free to help to fix it if you are interested in it.

yuluo-yx commented 10 months ago

hi @yuluo-yx , thanks for reporting this issue. Please feel free to help to fix it if you are interested in it.

It's a great honor, I will submit a PR soon to fix it, please assign to me @LinuxSuRen

yuluo-yx commented 10 months ago

I have an idea. In open source best practice projects, most of the content is displayed in text. We can establish a set of specifications for writing documents to provide reference when writing documents to avoid these problems.

LinuxSuRen commented 10 months ago

I have an idea. In open source best practice projects, most of the content is displayed in text. We can establish a set of specifications for writing documents to provide reference when writing documents to avoid these problems.

Of course, it could be wonderful if you could take the initiative to make a start. It is crucial to encourage greater collaboration among all stakeholders in this project.

I have a new idea. We could also convert the Markdown files into a PDF. And publish it in GitHub release.

yuluo-yx commented 10 months ago

Very happy to contribute to this. 💪

yuluo-yx commented 10 months ago

I have a new idea. We could also convert the Markdown files into a PDF. And publish it in GitHub release.

A good idea, we can write a roadmap document for this to record some of our ideas and implement them later. 😄

yuluo-yx commented 10 months ago

image

image

In this case, it should be a problem with the page display. The file format is normal when viewed in the editor.