moby / moby/swarmkit

Reorganize protobuf files

Open
#111 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/api priority/P3 refactor
Dominant language
Go
Stars
3.7k
Forks
676
Avg merge
4d 9h
Merged PRs (30d)
6

Description

Currently, all proto files are in the api subdirectory. We may want to move to a model where proto files live in subdirectories of the Go modules that use them.

i.e.:

  • dispatcher/pb
  • manager/pb
  • manager/state/pb

etc.

cc @stevvooe

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 inventorying the proto files currently under the api subdirectory and the Go modules that use them. Compare the proposed dispatcher/pb, manager/pb, and manager/state/pb layout, then verify that all references and generated outputs still resolve after the reorganization.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.