PR linter
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.4k
- Forks
- 215
- Avg merge
- 2h 9m
- Merged PRs (30d)
- 27
Description
PRs that change certain things should require new/changed example wing files to ensure coverage is available for the various tests that consume those files.
Feature Spec
Suggested projects to require test cases:
- tree-sitter-wing
- wingc (maybe only certain files, like the parser/typechecker/jsify)
Use Cases
Testing is often easy to forget, but for such foundational changes, we should nudge contributors to add bare minimum testing.
Implementation Notes
I think it would be interesting to look into generic tooling to support PR lints. e.g. https://danger.systems/js/
Also note we use mergify, which can also help
Component
- Development Environment
- Contributor Experience
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin with the tree-sitter-wing and wingc projects and the Mergify configuration; the issue suggests Danger.js as a generic PR-linting option. Decide which changes require new or changed example Wing files, then verify the lint catches missing coverage without overrequiring unrelated changes.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100