AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Repetition, consistency, formatting and tense inaccuracies

Ouverte
#219 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Aucune donnée de langage
Étoiles
109
Forks
108
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

https://github.com/AppFlowy-IO/AppFlowy-Docs/blob/25b257ed20e86ededcf0337049fc07d7247d6e34/essential-documentation/contribute-to-appflowy/appflowy-mentorship-program/mentorship-2022/mentee-projects/importers.md?plain=1#L114

***1. Unnecessary Repetition & Informal Phrase***
Inaccurate:
"`Like For` example" → "Like" and "For example" serve the same purpose; using both is redundant.
Accurate:
Use either "For example" or "Like" (though "For example" is more formal).

***2. Comma Misplacement & Formatting***
Inaccurate:
"the main page will be level 1` , `if it has a subpage it will be level 2" → Incorrect comma placement
Accurate:
"the main page will be level 1`. `If it has a subpage`,` it will be level 2."

***3. Tense & Consistency***
Inaccurate:
"if that subpage `will have` another subpage that `would belong` to level 3" → "will have" and "would belong" mix future and conditional tense.
Accurate:
should be "if that subpage `has` another subpage`, it will` belong to level 3."

Also, please ensure that level 1, level 2, and level 3 are consistently formatted, either using numerals (1, 2, 3) or written out in words (One, Two, Three).

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.