wordpress-mobile / wordpress-mobile/release-toolkit

Static Type Checking 🤔

Open
#201 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
31
Forks
10
Avg merge
5h 45m
Merged PRs (30d)
2

Description

What do you think of adding static type checking, either via RBS (which would require upgrading to Ruby 3.x RBS requires Ruby >= 2.6) or sorbet?

I love that we are putting effort in documentation and writing good Ruby to help us compensate for the lack of type checking. Those are great initiatives that we should definitely pursue but I wonder if we could augment them with the introduction of static type checking.

@jkmassel showed me a similar approach using Psalm for PHP in an internal project and I found it super useful.

Note: I never used either of those tools but I imagine seriously adopting them would be quite a process. I'm not arguing we should jump onto it right away, I'm just curious of your opinion. If there's interest, we should run an humble spike first, just to see if it's straightforward to adopt them and if type-annotated classes can coexist with non-type-annotated ones, allowing us a gradual adoption path.

Contributor guide

Open the contributing guide

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.

Research direction

No specific files or tests are named. Start by reviewing the Ruby release-toolkit code and comparing RBS with Sorbet for adoption effort; a useful spike should establish whether typed and untyped classes can coexist and whether gradual adoption is practical.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.