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

Aberta
  • Algo errado?
#355 2 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 1 dia

@Ravindar-Amogh-Gummadavelly já está trabalhando nisso.

Desde 31/10/2026.

Avaliação

Esta issue ainda não foi avaliada.

Descrição

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.

Linguagem predominante
TypeScript
Estrelas
8
Forks
4
Merge médio
8h 41min
PRs com merge (30d)
158

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de codercops/ogcops

Todas as issues de codercops/ogcops

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.