Appending to log.md drops the frontmatter the file carried

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
57/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp, markdown, yaml
Domain
backend, cli

Research direction

Start in src/OKF4net with BundleConceptWriter.AppendLog and the ChangeLog rewrite path; trace how okf_append_log reads and writes log.md, then inspect the existing tests and goldens. Add coverage for logs with and without frontmatter, and preserve the frontmatter byte-for-byte or document a clear refusal. Done when both cases pass and existing goldens remain unchanged.

Written by the indexing model from the issue text.

Description

.NET bug

Area

src/OKF4net — BundleConceptWriter.AppendLog / ChangeLog rewrite of log.md; tool okf_append_log.

Problem

Appending an entry rewrites log.md through the §9 model and drops a frontmatter block the file carried. Content the author wrote is lost without warning. (Knock-on: the root index then lists the log by file stem under # Other.)

§9 does not give log.md a frontmatter, but the library's general rule is that unknown producer content survives a round-trip.

Acceptance

  • An append to a log.md that has a frontmatter keeps that frontmatter byte-for-byte (or the append is refused with a clear message — decide and document).
  • Tests for a log with and without frontmatter; goldens unchanged.

Found while building the #160 sample.

Dominant language
C#
Stars
4
Forks
1
Avg merge
1d 4h
Merged PRs (30d)
32

Getting set up

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 jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.