Add guidelines for formatting questions and explanations

Abierto
  • ¿Algo no está bien?
#357 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
cpp, markdown
Área
content, documentation

Línea de trabajo

Comienza revisando las convenciones existentes del repositorio para las preguntas y las explicaciones, y después compara cada una de las 17 reglas propuestas con el contenido actual. La tarea estará completada cuando exista un conjunto coherente de directrices de formato, aprobado por un maintainer, con un alcance y una redacción claros.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Suggestions from @tocic:

<changes> — <reason> — <automatable>:

  1. use ``` instead of for code blocks (even inside quotes) — easier to read/write, code highlighting — greppable
  2. no using namespace std; — more vertical space — clang-tidy/greppable
  3. no EOL at EOF — consistency — clang-format can consistently do the opposite
  4. 2 or 4 spaces for code indentation — consistency, more horizontal space — clang-format
  5. (...) for omitting, [some text] for our remarks inside references — consistency — not
  6. */** instead of _/__ — consistency, to support _ in refs — not
  7. https instead of http — security — greppable
  8. strip whitespace — easier to read — git
  9. remove/replace non-printable chars — looks like they are present in the original standard draft so we can ignore them in the future — greppable
  10. add missing punctuation — consistency, easier to read — partially greppable
  11. use > instead of "" for refs — easier to read, better highlighting — not
  12. empty line before a quote — consistency, easier to read in long explanations — greppable
  13. > instead of just > — consistency, easier to read — greppable
  14. use > (right angle bracket + newline) for linebreaks in quotes — vanilla markdown syntax, idk why it renders correctly without them — not
  15. try to preserve the original formatting in quotes — hightlighting, easier to match — not
  16. always add a hint — if there's "No hint", the user loses his score for nothing — greppable
  17. refer to ¶note-X and ¶general-example-Y directly where appropriate — no need to write [*Note X*: and — *end example*] — not
Lenguaje dominante
Python
Estrellas
130
Forks
15
Merge medio
1 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de knatten/cppquiz

Todos los issues de knatten/cppquiz

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.