the-turing-way/reproducible-project-template

Use of heading syntax in CONTRIBUTING.md

Aperta

#4 aperta il 3 giu 2025

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari) (14 fork)auto 404
good first issue

Metriche repository

Star
 (43 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Summary

CONTRIBUTING.md uses section breaks rather than heading syntax to differentiate paragraphs. For accessibility to screen readers, I think proper heading syntax would be preferable.

What needs to be done?

  • Confirm accessibility of section breaks rather then heading to tax for a screen readers
  • replace section brakes with heading syntax

Who can help?

  • Anyone with basic markdown experience

Updates

  • [Replace this sentence to provide a status summary after the issue has been opened. To avoid others from reading through the full thread of comments, please share updates (e.g. decisions taken) regularly.]

Guida contributor

Direzione di ricerca
Sostituisci le interruzioni di sezione con la sintassi di intestazione appropriata in CONTRIBUTING.md e verifica l'accessibilità con un test dello screen reader.
Tech stack
Nessuno
Dominio
documentationaccessibility
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85