Add the Do and Don't tutorial template (`tutorial-do-dont`)

Offen
  • Stimmt etwas nicht?
#355 2 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@Ravindar-Amogh-Gummadavelly arbeitet bereits daran.

Seit 31.10.2026.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

good first issue templates

Part of #5. For tips posts that show the right way and the wrong way side by side.

Idea
The title at the top ("Writing commit messages"), then two columns: "Do" on the left with up to three items ("Use the imperative mood", "Keep the subject under 50 characters", "Explain why in the body") and "Don't" on the right with up to three items ("End the subject with a period", "Mix unrelated changes", "Write fixed stuff"). The "Do" heading is green and the "Don't" heading is red, each item sits on its own row, and the site name is at the bottom.

Template details

  • File: src/templates/tutorial/do-dont.ts, id tutorial-do-dont
  • Fields: commonFields.title, do1 to do3 (text, optional, defaults above), dont1 to dont3 (text, optional, defaults above), commonFields.siteName, commonFields.bgColor, commonFields.accentColor, commonFields.textColor

Where to look

  • Closest reference: src/templates/tutorial/before-after.ts (two columns side by side), src/templates/tutorial/prerequisites.ts (a short list where blank items are skipped)

Acceptance criteria

  • Blank items (or only spaces) are skipped with no gap; a column with every item blank hides and the other one takes the full width; with both empty the area hides cleanly
  • A long title shrinks with autoFontSize() and then truncates, and a long item wraps to at most two lines and then truncates inside its column
  • The green and red headings and any accent text stay readable on a light background
  • Re-exported in src/templates/tutorial/index.ts and registered in the tutorial block of src/templates/registry.ts
  • Meets the shared template checklist in #5

One template per contributor at a time, so more people get a chance.

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #NUM in the description.

Vorherrschende Sprache
TypeScript
Sterne
8
Forks
4
Ø Merge
8 Std. 44 Min.
Gemergte PRs (30 T.)
158

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 codercops/ogcops

Alle Issues in codercops/ogcops

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

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