Add guidelines for formatting questions and explanations

Offen
  • Stimmt etwas nicht?
#357 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
cpp, markdown
Bereich
content, documentation

Rechercherichtung

Beginne damit, die bestehenden Konventionen des Repositorys für Fragen und Erklärungen zu prüfen, und vergleiche anschließend jede der 17 vorgeschlagenen Regeln mit den aktuellen Inhalten. Abgeschlossen ist die Aufgabe, wenn ein von einem Maintainer genehmigter, konsistenter Satz von Formatierungsrichtlinien mit klarem Geltungsbereich und eindeutiger Formulierung vorliegt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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
Vorherrschende Sprache
Python
Sterne
130
Forks
15
Ø Merge
1 Min.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus knatten/cppquiz

Alle Issues in knatten/cppquiz

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.