Record frame: remaining review nits (PR #147)

Open
  • Is something wrong?
#154 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp
Domain
backend

Research direction

Read the listed code locations in RecordFileReader.cs, RecordRoot.cs, and RecordJsonSchema.cs, then review reports/te-review-record-frame.md and the fixtures under records/. Start by separating the parser, validation, schema, fixture, and depth-limit items into independently scoped changes. Done means each selected review nit has a focused fix and regression coverage; the issue lists several unrelated items, so a first contributor should coordinate which one to take.

Written by the indexing model from the issue text.

Description

From H:\work\gdr-design-20261102\reports\te-review-record-frame.md P3s not fixed in the PR:

  • A tab or several spaces after key: gets no scalar-style finding, so a rewrite changes bytes silently.
  • A raw tab in a plain-text block reads as a space with only an info finding (RecordFileReader.cs:777-786).
  • RecordRoot.cs:30-40: /objects/ accepted as a whole record of the file's kind; top folder never checked.
  • RecordJsonSchema.cs:23 hardcodes fwmd 1; :70 '--frame' definition name can collide.
  • RecordFileReader.cs:855: a notation fix with several edits is dropped silently.
  • Fixtures: reused ids (fwmd.ws.unknown, fwmd.syntax.unknown-attribute, fwmd.env.unknown-class) have no ok: negatives in records/; more syntax-error cases.
  • Watch: YamlDotNet takes 1.8 s on an unclosed [ nested 20,000 deep; consider a depth cap.
Dominant language
C#
Stars
0
Forks
0
Avg merge
1h 43m
Merged PRs (30d)
43

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 sillsdev/SIL.TextEditing

All issues in sillsdev/SIL.TextEditing

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.