the-turing-way/reproducible-project-template

Use of heading syntax in CONTRIBUTING.md

Open

#4 opened on Jun 3, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees) (14 forks)auto 404
good first issue

Repository metrics

Stars
 (43 stars)
PR merge metrics
 (PR metrics pending)

Description

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.]

Contributor guide

Research direction
Replace section breaks with proper heading syntax in CONTRIBUTING.md and verify accessibility with screen reader testing.
Tech stack
None
Domain
documentationaccessibility
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85