pytorch / pytorch/executorch

Try renaming `shim/` to make it more clear that it's an internal/infra concept

Open
#6,862 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

actionable module: build/install triaged
Dominant language
Python
Stars
5k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
581

Description

As described in https://github.com/pytorch/executorch/pull/6860, the shim/ tree exists to make the buck2 build system work in both Meta internal and open-source repos. But no-one should really be looking at it most of the time, and it's more of a config thing than a part of the core tree.

We should see if we could rename it to something like .shim or build/buck2-shims. This would make it more clear that it's an internal config thing.

The main trick is that we need to coordinate this with the Meta-internal code mirroring config when we make the change.

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

Start by reading PR #6860 and inspecting the shim/ tree and the Meta-internal code mirroring configuration. Determine whether .shim or build/buck2-shims fits the repository structure; done means the rename is coordinated with mirroring and the Buck2 setup continues to work in both internal and open-source repositories.

Written by the indexing model from the issue text.

Assessment

Domain
build-system
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.