winglang/wing

PR linter

Open

#482 opened on Nov 7, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue👷‍♀️ contributor-experience

Repository metrics

Stars
 (5,385 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate setting up Danger JS (https://danger.systems/js) to lint PRs and enforce test case requirements for changes to specific projects like tree sitter wing and wingc. Look into Mergify integration as well.
Tech stack
typescript
Domain
developer experiencetoolingci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitCI/CD
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60