AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Repetition, consistency, formatting and tense inaccuracies

Abierto
#219 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Sin datos de lenguaje
Estrellas
109
Forks
108
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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).

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.