whats-new drafts from player-facing notes first (whatsNew.source, docs/RELEASE-<version>.md, the CHANGELOG section of the version or Unreleased; --release, --from-git) and only then from the git log; internal jargon warnings (SDK / vendor names, developer and version-control words, file paths, issue ids, code identifiers) with plain alternatives in the draft and whats-new check, one list in cli/lib/jargon.ts, whatsNew.allowWords keeps a word; skill: write from what players feel, never from commit messages; tests
This commit is contained in:
parent
e9507d8884
commit
bab3f63227
9 changed files with 287 additions and 21 deletions
|
|
@ -206,7 +206,7 @@ describe('whats-new', () => {
|
|||
expect([...formatNotes(many, { limit: 500 })].length).toBeLessThanOrEqual(500);
|
||||
expect(formatNotes([], { limit: 500 })).toBe('Bug fixes and performance improvements.');
|
||||
expect(checkNotes('x'.repeat(501), 'play')[0]).toContain('501 > 500');
|
||||
expect(checkNotes('bump version', 'apple')[0]).toContain('commit log');
|
||||
expect(checkNotes('bump version', 'apple')[0]).toBe('internal jargon (developer word): "bump"; instead: "update"');
|
||||
});
|
||||
test('writes into both listing files, keeping them parseable', () => {
|
||||
const play = readFileSync(join(T, 'listing.md'), 'utf8');
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue