WorldconVotingSystems/nomnom

Provide clear documentation about where changes to text should happen

Open

#228 opened on Feb 16, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (13 forks)auto 404
administrator-featuredocumentationgood first issuenice-to-have

Repository metrics

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

Description

Right now it's not obvious if a change should be in NomNom or in the convention-specific templates. Most of them should be in the latter, but that's far from obvious.

See:

  • WorldconVotingSystems/seattle-2025#25 - convention-specific
  • WorldconVotingSystems/seattle-2025#24 - convention-specific
  • WorldconVotingSystems/nomnom#220 - might be a bug in NomNom, might be convention-specific

It would be very useful to make that clearer, so that Hugo team folks know where to make issues and how to update text.

Contributor guide

Research direction
Investigate the existing documentation in NomNom and convention specific templates to determine where changes should be made.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
75