@v587d/capital-generation 2.7.1 → 2.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/CHANGELOG.md +80 -0
  2. package/README.md +9 -7
  3. package/THIRD_PARTY_NOTICES.md +65 -24
  4. package/capital-config/client.js +2 -2
  5. package/capital-config/package.json +1 -1
  6. package/capital-watchlist/package.json +1 -1
  7. package/chart-ui/package.json +1 -1
  8. package/lib/web-retriever/local-fetch.d.ts +1 -1
  9. package/lib/web-retriever/local-fetch.js +1 -1
  10. package/lib/web-retriever/wind-client.d.ts +1 -1
  11. package/lib/web-retriever/wind-client.js +1 -1
  12. package/package.json +3 -1
  13. package/selected-skills/InvestSkill/UPSTREAM.md +9 -0
  14. package/selected-skills/catalog.js +200 -0
  15. package/selected-skills/china-stock-research-skills/UPSTREAM.md +2 -1
  16. package/selected-skills/investment-skills/UPSTREAM.md +2 -1
  17. package/selected-skills/peter-lynch-skill/LICENSE +21 -0
  18. package/selected-skills/peter-lynch-skill/UPSTREAM.md +72 -0
  19. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/SKILL.md +142 -0
  20. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/deep/methodology.md +587 -0
  21. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/deep/system-prompt.md +102 -0
  22. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/deep/web-research.md +471 -0
  23. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/disclaimer.md +2 -0
  24. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/filing-rules.md +64 -0
  25. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/quick/methodology.md +195 -0
  26. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/quick/system-prompt.md +72 -0
  27. package/selected-skills/peter-lynch-skill/skills/peter-lynch-skill/references/quick/web-research.md +379 -0
  28. package/selected-skills/trading-skills/LICENSE +21 -0
  29. package/selected-skills/trading-skills/UPSTREAM.md +111 -0
  30. package/selected-skills/trading-skills/skills/catalyst-map/SKILL.md +119 -0
  31. package/selected-skills/trading-skills/skills/catalyst-map/references/catalyst-framework.md +68 -0
  32. package/selected-skills/trading-skills/skills/earnings-preview/SKILL.md +124 -0
  33. package/selected-skills/trading-skills/skills/earnings-preview/references/data-providers.md +26 -0
  34. package/selected-skills/trading-skills/skills/earnings-preview/references/providers/fmp.md +49 -0
  35. package/selected-skills/trading-skills/skills/earnings-preview/references/providers/polygon.md +45 -0
  36. package/selected-skills/trading-skills/skills/earnings-preview/references/providers/tradingeconomics.md +49 -0
  37. package/selected-skills/trading-skills/skills/earnings-preview/references/relevance-ranking.md +24 -0
  38. package/selected-skills/trading-skills/skills/earnings-trade-prep/SKILL.md +134 -0
  39. package/selected-skills/trading-skills/skills/earnings-trade-prep/references/workflow-framework.md +65 -0
  40. package/selected-skills/trading-skills/skills/evidence-gap-check/SKILL.md +120 -0
  41. package/selected-skills/trading-skills/skills/evidence-gap-check/references/gap-framework.md +66 -0
  42. package/selected-skills/trading-skills/skills/execution-plan-check/SKILL.md +121 -0
  43. package/selected-skills/trading-skills/skills/execution-plan-check/references/execution-checklist.md +70 -0
  44. package/selected-skills/trading-skills/skills/journal-pattern-analyzer/SKILL.md +120 -0
  45. package/selected-skills/trading-skills/skills/journal-pattern-analyzer/references/calculation-helpers.md +16 -0
  46. package/selected-skills/trading-skills/skills/journal-pattern-analyzer/references/pattern-framework.md +74 -0
  47. package/selected-skills/trading-skills/skills/macro-event-analysis/SKILL.md +122 -0
  48. package/selected-skills/trading-skills/skills/macro-event-analysis/references/data-providers.md +23 -0
  49. package/selected-skills/trading-skills/skills/macro-event-analysis/references/interpretation-guide.md +22 -0
  50. package/selected-skills/trading-skills/skills/macro-event-analysis/references/providers/fmp.md +28 -0
  51. package/selected-skills/trading-skills/skills/macro-event-analysis/references/providers/tradingeconomics.md +40 -0
  52. package/selected-skills/trading-skills/skills/market-regime-analysis/SKILL.md +117 -0
  53. package/selected-skills/trading-skills/skills/market-regime-analysis/references/data-providers.md +26 -0
  54. package/selected-skills/trading-skills/skills/market-regime-analysis/references/providers/fmp.md +46 -0
  55. package/selected-skills/trading-skills/skills/market-regime-analysis/references/providers/polygon.md +36 -0
  56. package/selected-skills/trading-skills/skills/market-regime-analysis/references/providers/tradingeconomics.md +46 -0
  57. package/selected-skills/trading-skills/skills/market-regime-analysis/references/regime-framework.md +23 -0
  58. package/selected-skills/trading-skills/skills/portfolio-concentration/SKILL.md +119 -0
  59. package/selected-skills/trading-skills/skills/portfolio-concentration/references/concentration-framework.md +72 -0
  60. package/selected-skills/trading-skills/skills/portfolio-risk-review/SKILL.md +126 -0
  61. package/selected-skills/trading-skills/skills/portfolio-risk-review/references/workflow-framework.md +57 -0
  62. package/selected-skills/trading-skills/skills/position-management/SKILL.md +120 -0
  63. package/selected-skills/trading-skills/skills/position-management/references/management-framework.md +70 -0
  64. package/selected-skills/trading-skills/skills/position-sizing/SKILL.md +83 -0
  65. package/selected-skills/trading-skills/skills/position-sizing/assets/trade-plan-template.md +15 -0
  66. package/selected-skills/trading-skills/skills/position-sizing/references/calculation-helpers.md +13 -0
  67. package/selected-skills/trading-skills/skills/position-sizing/references/methodology.md +28 -0
  68. package/selected-skills/trading-skills/skills/post-trade-debrief/SKILL.md +99 -0
  69. package/selected-skills/trading-skills/skills/post-trade-debrief/references/workflow-framework.md +51 -0
  70. package/selected-skills/trading-skills/skills/post-trade-review/SKILL.md +82 -0
  71. package/selected-skills/trading-skills/skills/post-trade-review/references/review-rubric.md +34 -0
  72. package/selected-skills/trading-skills/skills/pre-trade-check/SKILL.md +136 -0
  73. package/selected-skills/trading-skills/skills/pre-trade-check/references/workflow-framework.md +61 -0
  74. package/selected-skills/trading-skills/skills/risk-reward-sanity-check/SKILL.md +81 -0
  75. package/selected-skills/trading-skills/skills/risk-reward-sanity-check/references/calculation-helpers.md +14 -0
  76. package/selected-skills/trading-skills/skills/risk-reward-sanity-check/references/failure-modes.md +9 -0
  77. package/selected-skills/trading-skills/skills/thesis-validation/SKILL.md +123 -0
  78. package/selected-skills/trading-skills/skills/thesis-validation/references/thesis-checklist.md +56 -0
  79. package/selected-skills/trading-skills/skills/watchlist-review/SKILL.md +119 -0
  80. package/selected-skills/trading-skills/skills/watchlist-review/references/review-framework.md +57 -0
  81. package/selected-skills/InvestSkill/ADDING-NEW-SKILLS.md +0 -546
  82. package/selected-skills/InvestSkill/CHANGELOG.md +0 -373
  83. package/selected-skills/InvestSkill/CI-CD-GUIDE.md +0 -432
  84. package/selected-skills/InvestSkill/CLAUDE.md +0 -148
  85. package/selected-skills/InvestSkill/CONTRIBUTING.md +0 -291
  86. package/selected-skills/InvestSkill/DEPLOYMENTS.md +0 -321
  87. package/selected-skills/InvestSkill/FAQ.md +0 -509
  88. package/selected-skills/InvestSkill/GEMINI.md +0 -419
  89. package/selected-skills/InvestSkill/PLATFORM-COMPATIBILITY.md +0 -529
  90. package/selected-skills/InvestSkill/README-claude-code.md +0 -435
  91. package/selected-skills/InvestSkill/README-cursor.md +0 -475
  92. package/selected-skills/InvestSkill/README-gemini.md +0 -532
  93. package/selected-skills/InvestSkill/README-ollama.md +0 -106
  94. package/selected-skills/InvestSkill/README-zh-TW.md +0 -461
  95. package/selected-skills/InvestSkill/README.md +0 -311
  96. package/selected-skills/InvestSkill/RELEASE-QUICK-REFERENCE.md +0 -230
  97. package/selected-skills/InvestSkill/RELEASE_NOTES.md +0 -121
  98. package/selected-skills/InvestSkill/SECURITY.md +0 -232
  99. package/selected-skills/InvestSkill/TODO.md +0 -28
  100. package/selected-skills/InvestSkill/package.json +0 -64
  101. package/selected-skills/InvestSkill/plugins/us-stock-analysis/README.md +0 -119
  102. package/selected-skills/china-stock-research-skills/.github/ISSUE_TEMPLATE/bug_report.md +0 -35
  103. package/selected-skills/china-stock-research-skills/.github/ISSUE_TEMPLATE/skill_request.md +0 -28
  104. package/selected-skills/china-stock-research-skills/.github/PULL_REQUEST_TEMPLATE.md +0 -15
  105. package/selected-skills/china-stock-research-skills/CHANGELOG.md +0 -59
  106. package/selected-skills/china-stock-research-skills/CONTRIBUTING.md +0 -121
  107. package/selected-skills/china-stock-research-skills/GITHUB_PUBLISHING.md +0 -259
  108. package/selected-skills/china-stock-research-skills/INSTALL.md +0 -151
  109. package/selected-skills/china-stock-research-skills/PUBLISH_CHECKLIST.md +0 -165
  110. package/selected-skills/china-stock-research-skills/README.en.md +0 -209
  111. package/selected-skills/china-stock-research-skills/README.md +0 -209
  112. package/selected-skills/china-stock-research-skills/RELEASE_ASSETS.md +0 -222
  113. package/selected-skills/china-stock-research-skills/ROADMAP.md +0 -45
  114. package/selected-skills/china-stock-research-skills/SKILLS.md +0 -85
  115. package/selected-skills/china-stock-research-skills/examples/full-report-flow.md +0 -20
  116. package/selected-skills/china-stock-research-skills/examples/module-select-cases.md +0 -26
  117. package/selected-skills/china-stock-research-skills/examples/quickstart-prompts.md +0 -25
  118. package/selected-skills/investment-skills/.github/workflows/validate.yml +0 -25
  119. package/selected-skills/investment-skills/.tbd/config.yml +0 -107
  120. package/selected-skills/investment-skills/README.md +0 -253
  121. package/selected-skills/investment-skills/docs/development.md +0 -37
  122. package/selected-skills/investment-skills/docs/roadmap.md +0 -25
@@ -1,121 +0,0 @@
1
- # 贡献指南 / Contributing
2
-
3
- [中文](#中文) | [English](#english)
4
-
5
- ## 中文
6
-
7
- 感谢你考虑为这个仓库贡献内容。
8
-
9
- ### 欢迎的贡献类型
10
-
11
- - 提升现有 skills 的清晰度和边界感
12
- - 增加新的、可复用的 A 股研究 overlays
13
- - 改进来源与引用规范
14
- - 增加能帮助新用户上手的 examples
15
- - 修复会模糊 `事实`、`解读`、`待验证问题` 边界的措辞
16
-
17
- ### 提交 PR 前请注意
18
-
19
- - 保持主流程是“通用 A 股研究框架”
20
- - 优先沉淀可复用模式,不要把流程写死到单一公司或单一行业
21
- - 只要新增来源指引,就补充可访问链接
22
- - `SKILL.md` 保持简洁,把细节尽量下沉到 `references/`
23
- - 默认输出语言应为简体中文,除非用户明确要求其他语言
24
-
25
- ### Skill 结构要求
26
-
27
- 每个 skill 至少应包含:
28
-
29
- - 合法 frontmatter,其中必须有 `name` 和 `description`
30
- - 清晰的 `When to Use`
31
- - 清晰的 `Workflow`
32
- - 清晰的 `Required Output`
33
- - 清晰的 `Boundaries`
34
-
35
- ### 引用要求
36
-
37
- - 每条关键事实都应指向可访问来源链接
38
- - 官方披露优先于媒体或评论
39
- - 不要把没有证据支撑的推断写进 `事实`
40
-
41
- ### 本地检查
42
-
43
- 在仓库根目录执行:
44
-
45
- ```bash
46
- bunx skills add . --list
47
- python3 ~/.config/opencode/skills/skill-creator/scripts/quick_validate.py skills/<skill-name>
48
- ```
49
-
50
- ### 范围建议
51
-
52
- 优先:
53
-
54
- - 小步、可组合的改进
55
- - 一次新增一个 overlay
56
- - 围绕可复用模式设计 examples
57
-
58
- 避免:
59
-
60
- - 把仓库改造成交易系统
61
- - 依赖私有数据库或付费终端
62
- - 在主流程里硬编码某只股票或某个行业
63
-
64
- ## English
65
-
66
- Thanks for considering a contribution.
67
-
68
- ### Good Contribution Types
69
-
70
- - Improve clarity and boundaries of existing skills
71
- - Add reusable overlays for common A-share research patterns
72
- - Improve source and citation standards
73
- - Add examples that help first-time users
74
- - Fix wording that blurs the boundaries between `Facts`, `Interpretation`, and `Open Questions`
75
-
76
- ### Before Opening a PR
77
-
78
- - Keep the core workflow generic for A-share stock research
79
- - Prefer reusable patterns over one-company or one-industry hardcoding
80
- - Add accessible source links when introducing new source guidance
81
- - Keep `SKILL.md` files concise and push detail into `references/`
82
- - Default output language should remain Simplified Chinese unless the user explicitly requests another language
83
-
84
- ### Skill Structure Expectations
85
-
86
- Every skill should include:
87
-
88
- - valid frontmatter with `name` and `description`
89
- - clear `When to Use`
90
- - clear `Workflow`
91
- - clear `Required Output`
92
- - clear `Boundaries`
93
-
94
- ### Citation Expectations
95
-
96
- - Every key fact should point to an accessible source link
97
- - Official disclosures should outrank commentary or media
98
- - Do not merge unsupported inference into `Facts`
99
-
100
- ### Local Checks
101
-
102
- From the repository root:
103
-
104
- ```bash
105
- bunx skills add . --list
106
- python3 ~/.config/opencode/skills/skill-creator/scripts/quick_validate.py skills/<skill-name>
107
- ```
108
-
109
- ### Scope Guidance
110
-
111
- Prefer:
112
-
113
- - small, composable improvements
114
- - one new overlay at a time
115
- - examples based on reusable patterns
116
-
117
- Avoid:
118
-
119
- - turning the pack into a trading system
120
- - depending on private databases or paid terminals
121
- - hardcoding one stock or one sector into the main workflow
@@ -1,259 +0,0 @@
1
- # GitHub 发布指南 / GitHub Publishing Guide
2
-
3
- [中文](#中文) | [English](#english)
4
-
5
- ## 中文
6
-
7
- 这份文件用于帮助你在将仓库公开到 GitHub 前,做最后一轮发布收尾。
8
-
9
- ### 建议仓库名
10
-
11
- - `china-stock-research-skills`
12
-
13
- 简短、直观、易记。
14
-
15
- ### 建议的 GitHub Description
16
-
17
- - `面向中国股票、尤其是 A股 / A-share 研究的开源 agent skills,强调工作流编排、证据优先分析与可复用 overlays。`
18
-
19
- 如果你更希望 description 用英文,也可以使用:
20
-
21
- - `Open-source agent skills for China stock and A-share research, with orchestrated workflows, citation-first analysis, and reusable sector overlays.`
22
-
23
- ### 建议 Topics
24
-
25
- - `a-share`
26
- - `ashare`
27
- - `china-stock`
28
- - `china-a-share`
29
- - `stock-research`
30
- - `equity-research`
31
- - `agent-skills`
32
- - `claude-code`
33
- - `opencode`
34
- - `codex`
35
- - `investment-research`
36
- - `financial-analysis`
37
- - `company-research`
38
-
39
- ### 建议 Homepage
40
-
41
- - 初期可以留空,或者直接指向仓库自身
42
- - 只有在你后续建立独立文档页或项目主页时,再补 homepage
43
-
44
- ### 建议 Social Preview 文案
45
-
46
- - `面向中国股票、尤其是 A股结构化研究的开源 skills pack。强调证据优先、模块化设计与 agent 工作流。`
47
-
48
- ### 首个版本 Tag
49
-
50
- - `v0.1.0`
51
-
52
- 这个版本已经具备较完整的首发条件,因为它包含:
53
-
54
- - 1 个 orchestrator skill
55
- - 6 个核心研究模块
56
- - 共享来源与引用标准
57
- - 面向常见 A 股研究问题的可复用 overlays
58
- - 安装、使用、贡献、示例等基础文档
59
-
60
- ### 首个 Release 标题
61
-
62
- - `v0.1.0 - 首个开源版本`
63
-
64
- ### 首个 Release Notes
65
-
66
- ```md
67
- ## 亮点
68
-
69
- - 新增 `china-stock-research-orchestrator`,用于把一只股票路由到合适的研究流程
70
- - 提供 6 个核心 A 股研究模块,覆盖战略、业务质量、财务健康度、竞争格局、风险监测、估值框架
71
- - 新增证据优先的共享标准,要求关键事实附可访问来源链接
72
- - 新增可复用 overlays,覆盖业务转型、订单驱动、重资产爬坡、周期、消费品牌、医药政策、出口制造等常见场景
73
- - 将 IDC 保留为可选示例 overlay,而不是默认假设
74
-
75
- ## 本版本包含
76
-
77
- - `china-stock-research-orchestrator`
78
- - `strategy-business-transition`
79
- - `business-decomposition-order-quality`
80
- - `financial-health`
81
- - `industry-competition-moat`
82
- - `risk-warning-catalysts`
83
- - `valuation-investment-strategy`
84
-
85
- ## 文档
86
-
87
- - `README.md`
88
- - `INSTALL.md`
89
- - `SKILLS.md`
90
- - `CONTRIBUTING.md`
91
- - `ROADMAP.md`
92
- - `examples/`
93
-
94
- ## 说明
95
-
96
- - 本项目面向基于公开信息的中国股票研究工作流,尤其适合 A股 / A-share 场景
97
- - 它不是实时行情工具,也不是投资建议系统
98
- ```
99
-
100
- ### 建议的发布前检查清单
101
-
102
- #### 发布前
103
-
104
- - 确认 `README.md` 从头到尾读起来顺畅
105
- - 确认 `LICENSE` 已存在
106
- - 确认 `bunx skills add . --list` 能发现全部 skills
107
- - 确认 examples 中的 skill 名称与仓库当前一致
108
- - 确认公开文档中没有残留本地私有路径
109
-
110
- #### 发布后
111
-
112
- - 在 GitHub 设置中补 description 和 topics
113
- - 创建 tag `v0.1.0`
114
- - 将上面的 release notes 粘贴到 GitHub Release 页面
115
- - 在新目录中测试远程安装:`bunx skills add spikeHongg/china-stock-research-skills --list`
116
- - 如有需要,可先自建一个 roadmap issue 方便外部用户了解后续计划
117
-
118
- ### 建议首批 Pin 的 Issues
119
-
120
- - `Roadmap: next overlays and example outputs`
121
- - `Request for feedback: install flow and first-use prompts`
122
-
123
- ### 之后可以再补的内容
124
-
125
- - `CODE_OF_CONDUCT.md`
126
- - `SECURITY.md`
127
- - 更完整的双语文档
128
- - 示例输出截图或快照
129
-
130
- ### 配套文件
131
-
132
- - `RELEASE_ASSETS.md`:可直接复制到 GitHub 的 about、release、issues 文案
133
- - `PUBLISH_CHECKLIST.md`:实际发布时可以逐步执行的 checklist
134
-
135
- ## English
136
-
137
- Use this file as the final polish checklist before making the repository public on GitHub.
138
-
139
- ### Recommended Repository Name
140
-
141
- - `china-stock-research-skills`
142
-
143
- Short, descriptive, and easy to remember.
144
-
145
- ### Recommended GitHub Description
146
-
147
- - `Open-source agent skills for China stock and A-share research, with orchestrated workflows, citation-first analysis, and reusable sector overlays.`
148
-
149
- ### Recommended Topics
150
-
151
- - `a-share`
152
- - `ashare`
153
- - `china-stock`
154
- - `china-a-share`
155
- - `stock-research`
156
- - `equity-research`
157
- - `agent-skills`
158
- - `claude-code`
159
- - `opencode`
160
- - `codex`
161
- - `investment-research`
162
- - `financial-analysis`
163
- - `company-research`
164
-
165
- ### Suggested Homepage
166
-
167
- - Leave blank at first, or point it to the GitHub repository itself
168
- - Add a homepage later only if you create dedicated docs or a project page
169
-
170
- ### Suggested Social Preview Copy
171
-
172
- - `Open-source skills pack for structured China stock and A-share research. Citation-first, modular, and built for agent workflows.`
173
-
174
- ### First Release Tag
175
-
176
- - `v0.1.0`
177
-
178
- This version is a strong first public release because it already includes:
179
-
180
- - 1 orchestrator skill
181
- - 6 core research modules
182
- - shared source and citation standards
183
- - reusable overlays for common A-share analysis patterns
184
- - install docs, examples, and contribution docs
185
-
186
- ### First Release Title
187
-
188
- - `v0.1.0 - Initial open-source release`
189
-
190
- ### First Release Notes
191
-
192
- ```md
193
- ## Highlights
194
-
195
- - Add `china-stock-research-orchestrator` to route a stock into the right research workflow
196
- - Ship 6 core A-share research modules covering strategy, business quality, financial health, competition, monitoring, and valuation
197
- - Add citation-first shared standards with accessible source-link requirements
198
- - Add reusable overlays for business-model transition, project-order businesses, asset-heavy ramps, cyclicals, consumer brands, healthcare-policy cases, and export manufacturing
199
- - Keep IDC as an optional example overlay instead of a default assumption
200
-
201
- ## Included In This Release
202
-
203
- - `china-stock-research-orchestrator`
204
- - `strategy-business-transition`
205
- - `business-decomposition-order-quality`
206
- - `financial-health`
207
- - `industry-competition-moat`
208
- - `risk-warning-catalysts`
209
- - `valuation-investment-strategy`
210
-
211
- ## Documentation
212
-
213
- - `README.md`
214
- - `INSTALL.md`
215
- - `SKILLS.md`
216
- - `CONTRIBUTING.md`
217
- - `ROADMAP.md`
218
- - `examples/`
219
-
220
- ## Notes
221
-
222
- - This project is designed for public-information China stock research workflows, especially A-share use cases
223
- - It is not a real-time market data tool and not investment advice
224
- ```
225
-
226
- ### Suggested Launch Checklist
227
-
228
- #### Before Publishing
229
-
230
- - Confirm `README.md` reads well from top to bottom
231
- - Confirm `LICENSE` is present
232
- - Confirm `bunx skills add . --list` shows all expected skills
233
- - Confirm examples still match the current skill names
234
- - Confirm no local-only paths remain in public docs
235
-
236
- #### After Publishing
237
-
238
- - Add repository description and topics in GitHub settings
239
- - Create tag `v0.1.0`
240
- - Paste the release notes above into the GitHub release page
241
- - Test remote install from a fresh clone using `bunx skills add spikeHongg/china-stock-research-skills --list`
242
- - Open one self-filed issue for roadmap visibility, if desired
243
-
244
- ### Suggested First Pinned Issues
245
-
246
- - `Roadmap: next overlays and example outputs`
247
- - `Request for feedback: install flow and first-use prompts`
248
-
249
- ### Optional Nice-to-Haves Later
250
-
251
- - `CODE_OF_CONDUCT.md`
252
- - `SECURITY.md`
253
- - more complete bilingual docs
254
- - sample output snapshots
255
-
256
- ### Companion Files
257
-
258
- - `RELEASE_ASSETS.md`: copy-ready text for GitHub about, release notes, and pinned issues
259
- - `PUBLISH_CHECKLIST.md`: a step-by-step checklist for the actual launch
@@ -1,151 +0,0 @@
1
- # 安装 / Install
2
-
3
- [中文](#中文) | [English](#english)
4
-
5
- ## 中文
6
-
7
- 本仓库基于 open skills CLI 使用,面向中国股票、尤其是 A股 / A-share 研究场景,推荐使用 `bunx skills add` 进行安装与检查。
8
-
9
- ### 前置条件
10
-
11
- - 已安装 `bun`
12
- - 已安装支持 skills 的 agent 环境
13
-
14
- ### 从 GitHub 安装
15
-
16
- 可直接复制的远程安装命令:
17
-
18
- ```bash
19
- bunx skills add spikeHongg/china-stock-research-skills
20
- ```
21
-
22
- 如果想先看有哪些 skills:
23
-
24
- ```bash
25
- bunx skills add spikeHongg/china-stock-research-skills --list
26
- ```
27
-
28
- ### 从本地克隆目录安装
29
-
30
- 在仓库根目录执行:
31
-
32
- ```bash
33
- bunx skills add . --list
34
- ```
35
-
36
- 确认可发现后,再安装:
37
-
38
- ```bash
39
- bunx skills add .
40
- ```
41
-
42
- ### 如何验证安装成功
43
-
44
- 安装后,应当能看到以下 7 个 skills:
45
-
46
- - `china-stock-research-orchestrator`
47
- - `strategy-business-transition`
48
- - `business-decomposition-order-quality`
49
- - `financial-health`
50
- - `industry-competition-moat`
51
- - `risk-warning-catalysts`
52
- - `valuation-investment-strategy`
53
-
54
- ### 第一次使用
55
-
56
- 建议从总控母 skill 开始:
57
-
58
- ```text
59
- 使用 china-stock-research-orchestrator skill 分析这家中国上市公司,尤其按 A股 / A-share 研究语境识别主要分析模式,选择需要调用的模块,并返回一份带可访问来源链接的研究框架。所有中间与最终输出默认使用中文。
60
- ```
61
-
62
- ### 常见问题
63
-
64
- #### 找不到 skills
65
-
66
- - 确认本地安装时,你是在仓库根目录执行命令
67
- - 确认 `skills/` 下仍然存在有效的 `SKILL.md`
68
-
69
- #### 安装了但不知道怎么开始
70
-
71
- - 先从 `china-stock-research-orchestrator` 开始
72
- - 再查看 `SKILLS.md` 和 `examples/quickstart-prompts.md`
73
-
74
- #### 远程安装路径容易写错
75
-
76
- - 优先直接复制:`bunx skills add spikeHongg/china-stock-research-skills`
77
- - 本地调试时优先使用 `bunx skills add .`,不要先写很长的绝对路径
78
-
79
- ## English
80
-
81
- This repository is designed to work with the open skills CLI and is especially natural for China stock and A-share research workflows. The recommended install path is `bunx skills add`.
82
-
83
- ### Prerequisites
84
-
85
- - `bun` installed
86
- - a compatible agent environment that supports skills
87
-
88
- ### Install From GitHub
89
-
90
- Copy-paste remote install command:
91
-
92
- ```bash
93
- bunx skills add spikeHongg/china-stock-research-skills
94
- ```
95
-
96
- To inspect available skills before installing:
97
-
98
- ```bash
99
- bunx skills add spikeHongg/china-stock-research-skills --list
100
- ```
101
-
102
- ### Install From a Local Clone
103
-
104
- From the repository root:
105
-
106
- ```bash
107
- bunx skills add . --list
108
- ```
109
-
110
- Then install from the same local path:
111
-
112
- ```bash
113
- bunx skills add .
114
- ```
115
-
116
- ### Verify Installation
117
-
118
- After installation, you should be able to see these 7 skills:
119
-
120
- - `china-stock-research-orchestrator`
121
- - `strategy-business-transition`
122
- - `business-decomposition-order-quality`
123
- - `financial-health`
124
- - `industry-competition-moat`
125
- - `risk-warning-catalysts`
126
- - `valuation-investment-strategy`
127
-
128
- ### First Use
129
-
130
- Start with the orchestrator:
131
-
132
- ```text
133
- Use the china-stock-research-orchestrator skill to analyze this China-listed company, especially in an A-share workflow context, identify the main analysis patterns, choose the required modules, and return a source-backed research framework. Default all intermediate and final outputs to Simplified Chinese.
134
- ```
135
-
136
- ### Common Problems
137
-
138
- #### No skills found
139
-
140
- - Make sure you are running the command from the repository root when installing locally
141
- - Make sure valid `SKILL.md` files still exist under `skills/`
142
-
143
- #### Installed but hard to know where to start
144
-
145
- - Start with `china-stock-research-orchestrator`
146
- - Then review `SKILLS.md` and `examples/quickstart-prompts.md`
147
-
148
- #### Remote install path confusion
149
-
150
- - Use the copy-ready command first: `bunx skills add spikeHongg/china-stock-research-skills`
151
- - If you are testing locally, use `bunx skills add .` instead of a long absolute path
@@ -1,165 +0,0 @@
1
- # 发布执行清单 / Publish Checklist
2
-
3
- [中文](#中文) | [English](#english)
4
-
5
- ## 中文
6
-
7
- 这份文件是实际发布时可以按顺序执行的 checklist。
8
-
9
- ## 一、本地仓库准备
10
-
11
- 1. 确认当前目录文件齐全:`README.md`、`INSTALL.md`、`SKILLS.md`、`CONTRIBUTING.md`、`ROADMAP.md`、`CHANGELOG.md`、`GITHUB_PUBLISHING.md`、`RELEASE_ASSETS.md`
12
- 2. 检查 skills 是否可发现:
13
-
14
- ```bash
15
- bunx skills add . --list
16
- ```
17
-
18
- 3. 如果还没有初始化 git:
19
-
20
- ```bash
21
- git init
22
- git add .
23
- git commit -m "add initial China stock research skills pack"
24
- ```
25
-
26
- ## 二、创建 GitHub 仓库
27
-
28
- 1. 在 GitHub 创建新仓库
29
- 2. 仓库名建议使用:`china-stock-research-skills`
30
- 3. 在仓库设置中填写:
31
- - Description:使用 `RELEASE_ASSETS.md` 中的 About 文案
32
- - Topics:使用 `RELEASE_ASSETS.md` 中的 topics 建议
33
-
34
- ## 三、推送代码
35
-
36
- 假设远程仓库地址为 `<your-remote-url>`:
37
-
38
- ```bash
39
- git remote add origin <your-remote-url>
40
- git branch -M main
41
- git push -u origin main
42
- ```
43
-
44
- ## 四、创建首个版本
45
-
46
- 1. 创建 tag:
47
-
48
- ```bash
49
- git tag v0.1.0
50
- git push origin v0.1.0
51
- ```
52
-
53
- 2. 到 GitHub Release 页面新建 release
54
- 3. 标题建议:`v0.1.0 - 首个开源版本`
55
- 4. 正文直接复制 `RELEASE_ASSETS.md` 中的中文 release 正文
56
-
57
- ## 五、发布后验证
58
-
59
- 在一个新的目录中测试远程安装:
60
-
61
- ```bash
62
- mkdir -p /tmp/a-share-skills-test && cd /tmp/a-share-skills-test
63
- bunx skills add <owner>/<repo> --list
64
-
65
- 发布当前仓库时,对应命令是:
66
-
67
- ```bash
68
- bunx skills add spikeHongg/china-stock-research-skills --list
69
- ```
70
- ```
71
-
72
- 确认能看到全部 7 个 skills。
73
-
74
- 然后再测试一次使用入口:
75
-
76
- ```text
77
- 使用 china-stock-research-orchestrator skill 分析这家 A 股公司,识别主要分析模式,选择需要调用的模块,并默认使用中文输出。
78
- ```
79
-
80
- ## 六、建议的首批维护动作
81
-
82
- 1. 创建并 pin 两个 issues,可直接使用 `RELEASE_ASSETS.md` 中的标题与正文
83
- 2. 关注外部用户对安装流程与 examples 的反馈
84
- 3. 若发现远程安装说明不够清晰,优先更新 `INSTALL.md`
85
-
86
- ## English
87
-
88
- This file is a step-by-step execution checklist for the actual GitHub launch.
89
-
90
- ## 1. Prepare the Local Repository
91
-
92
- 1. Confirm the key files are present: `README.md`, `INSTALL.md`, `SKILLS.md`, `CONTRIBUTING.md`, `ROADMAP.md`, `CHANGELOG.md`, `GITHUB_PUBLISHING.md`, `RELEASE_ASSETS.md`
93
- 2. Check that the skills are discoverable:
94
-
95
- ```bash
96
- bunx skills add . --list
97
- ```
98
-
99
- 3. If git is not initialized yet:
100
-
101
- ```bash
102
- git init
103
- git add .
104
- git commit -m "add initial China stock research skills pack"
105
- ```
106
-
107
- ## 2. Create the GitHub Repository
108
-
109
- 1. Create a new repository on GitHub
110
- 2. Recommended name: `china-stock-research-skills`
111
- 3. In GitHub settings, fill in:
112
- - Description: use the About text from `RELEASE_ASSETS.md`
113
- - Topics: use the suggested topics from `RELEASE_ASSETS.md`
114
-
115
- ## 3. Push the Code
116
-
117
- Assuming the remote URL is `<your-remote-url>`:
118
-
119
- ```bash
120
- git remote add origin <your-remote-url>
121
- git branch -M main
122
- git push -u origin main
123
- ```
124
-
125
- ## 4. Create the First Release
126
-
127
- 1. Create the tag:
128
-
129
- ```bash
130
- git tag v0.1.0
131
- git push origin v0.1.0
132
- ```
133
-
134
- 2. Open the GitHub Releases page and create a release
135
- 3. Suggested title: `v0.1.0 - Initial open-source release`
136
- 4. Paste the release body from `RELEASE_ASSETS.md`
137
-
138
- ## 5. Post-Publish Verification
139
-
140
- In a fresh directory, test remote install:
141
-
142
- ```bash
143
- mkdir -p /tmp/a-share-skills-test && cd /tmp/a-share-skills-test
144
- bunx skills add <owner>/<repo> --list
145
-
146
- For this repository, the concrete command is:
147
-
148
- ```bash
149
- bunx skills add spikeHongg/china-stock-research-skills --list
150
- ```
151
- ```
152
-
153
- Confirm that all 7 skills are visible.
154
-
155
- Then test the entry prompt:
156
-
157
- ```text
158
- Use the china-stock-research-orchestrator skill to analyze this A-share company, identify the main analysis patterns, select the required modules, and default all outputs to Simplified Chinese.
159
- ```
160
-
161
- ## 6. Suggested First Maintenance Steps
162
-
163
- 1. Create and pin the two issues suggested in `RELEASE_ASSETS.md`
164
- 2. Watch for feedback on the install flow and examples
165
- 3. If remote install instructions cause confusion, update `INSTALL.md` first