Skip to content

Commit a4fc07e

Browse files
committed
test: add intentional lint errors to validate CI annotations
Temporary commit — will be reverted after confirming annotations appear on the PR diff.
1 parent 7ef2140 commit a4fc07e

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

docs/conventions/git-workflow.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,9 @@ with shared formatting and a separate API module.
7676
`post-test-results` commands
7777
```
7878

79-
**Bad** — structured template with headers, checklists, and badges:
79+
Keep descriptions to 1-3 sentences of plain prose. No markdown headers, checklists, or "generated by" badges. If a PR needs a long explanation, that's usually a sign it should be split up.
8080

81-
```
82-
## Summary
83-
- Add `GithubJobSummaryReporter` class
84-
- Refactor reporter code into `reporting/github/`
85-
86-
## Test plan
87-
- [ ] Build passes
88-
- [ ] Tests pass
89-
90-
🤖 Generated with [Claude Code](https://claude.com/claude-code)
91-
```
92-
93-
Keep descriptions to 1-3 sentences of plain prose. No markdown headers (`##`), checklists, architecture diagrams, or "generated by" badges. If a PR needs a long explanation, that's usually a sign it should be split up.
81+
The best PRs include a demo — a screenshot or short video showing the change in action. This is especially valuable for UI changes, new CLI output, or CI improvements where the effect isn't obvious from code alone.
9482

9583
## Branching
9684

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--[=[
2+
@class LintTest
3+
@unclosedtag
4+
]=]
5+
6+
local LintTest = {}
7+
LintTest.__index = LintTest
8+
9+
local unused = 1
10+
11+
return LintTest

0 commit comments

Comments
 (0)