Shopify / Shopify/tapioca

Merge gem annotations with gem RBIs to simplify user experience

Open
#1,516 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
873
Forks
164
Avg merge
4d 27m
Merged PRs (30d)
9

Description

We can merge the annotation RBIs with the gem RBI during tapioca gem command instead of relying on tapioca annotations.

I think not worrying about the annotations command can simplify the user experience. Also this will result in a single gem related RBI which conceptually is more consistent especially with the future plans of inline RBI versioning for the annotations.

Contributor guide

No contributing guide indexed for this repository

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

Start with the tapioca gem and tapioca annotations command entry points and compare how each produces gem RBIs and annotation RBIs. Define how the commands should interact and what a single gem-related RBI should contain, then verify that the annotations workflow is no longer needed for this use case.

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
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.