Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Configurer comments not working.

Open
#6 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
go, yaml
Domain
api, backend

Research direction

Start by tracing how YAML configuration is unmarshaled and how YAML nodes are rendered in the plugin API. Compare the API's handling of commented YAML with the reported node output and determine whether comments should be preserved without expanding a four-line configuration into the full node structure.

Written by the indexing model from the issue text.

Description

This is a two-part issue.
The first is that I cannot get any comments on my YAML config at all using any common trick.

When I finally use YAML nodes, the whole node structure is displayed with all the right contents(over 100 lines of it) for only a 4 line piece of information. Could it be an unmarshaling issue?
I also notice that the API manages to display nicely commented YAML file? Can I do the same thing if possible?

Dominant language
Go
Stars
16
Forks
4
PR merge metrics
No merged PRs in 30d

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.

More from gotify/plugin-api

All issues in gotify/plugin-api

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.