anza-xyz / anza-xyz/kit

Describe user group package hierarchy

未關閉
#1,437 7 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
TypeScript
星號
695
分支
210
平均合併
21 小時 33 分鐘
30 天內合併 PR
90

描述

## Motivation

I'm updating the CONTRIBUTING.md here - https://github.com/anza-xyz/kit/pull/1427 to give contributors a walkthrough of the various packages on this project. I've been looking at the package dependency trees and feel like the user and developer experience could be improved.

It seems like all the packages depend on each other whenever, and as needed. This creates confusion as to what packages are flexible building blocks vs. APIs for framework authors and end users (e.g. https://github.com/anza-xyz/kit/pull/1428).

## Details

It could be clearer which packages should be dependencies for others by sorting them into user groups. I'm proposing the hierarchy described by the chart below.

Obviously, nothing here is final. Within this framework, packages need to be created, moved around, and rethought. Happy to discuss further.

```
┌──────────────────────────────────────────┐
│ @solana/kit │
│ What non-framework developers │
│ install and use │
│ (Re-exports everything below) │
└─────────────────┬────────────────────────┘


┌──────────────────────────────────────────┐
│ Packages for Framework Authors │
│ Examples: │
│ • @solana/codecs │
│ • @solana/addresses │
│ • @solana/accounts │
└─────────────────┬────────────────────────┘


┌──────────────────────────────────────────┐
│ Building Blocks for Kit Contributors │
│ Examples: │
│ • @solana/codecs-core │
│ • @solana/codecs-data-structures │
│ • @solana/codecs-numbers │
└──────────────────────────────────────────┘

┌──────────────────────────────────────────┐
│ **Helper Packages │
│ (Used by all levels) │
│ │
│ Examples: │
│ • @solana/errors │
│ • @solana/nominal-types │
│ • @solana/assertions │
│ • @solana/webcrypto-ed25519-polyfill │
└──────────────────────────────────────────┘
```

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。