Azure / Azure/azure-sdk-tools

Organize apiviewgo code into packages

Open
#8,697 0 comments 0 reactions 0 assignees View on GitHub
APIView feature-request Go
Dominant language
C#
Stars
135
Forks
260
Avg merge
1d 22h
Merged PRs (30d)
115

Description

Currently, all business logic is stuffed into the `cmd` package. The code would be easier to navigate, and boundaries between types would be easier to maintain, if concerns were separated into subpackages. Something like:
```
cmd
├── cache
├── content
├── module
└── pkg
```
This would be a nontrivial refactoring because types in `cmd` commonly manipulate each others' unexported state.

Contributor guide

Open the contributing guide

Research direction

Start by reading the apiviewgo `cmd` package and mapping its business-logic types and their unexported-state dependencies. Use the proposed `cache`, `content`, `module`, and `pkg` subpackages as the target boundaries; done means the concerns are separated while their cross-package interactions remain functional.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Refactor
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.