WorldconVotingSystems / WorldconVotingSystems/nomnom

Provide clear documentation about where changes to text should happen

Open
#228 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

administrator-feature documentation good first issue nice-to-have
Dominant language
Python
Stars
17
Forks
15
Avg merge
11m
Merged PRs (30d)
1

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the three linked examples—seattle-2025#25, seattle-2025#24, and nomnom#220—to compare convention-specific and NomNom changes. Document where each kind of text change belongs, how Hugo team members should update text, and where they should file related issues.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.