Suggestions
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- go
调研方向
首先查看仓库 README 以及 docs/RFCS/20190318_error_handling.md 中链接的错误迁移部分,然后检查当前如何呈现 exthttp 和 extgrpc。该 issue 包含许多彼此独立的建议,因此首先确定一项达成共识的文档变更。完成标准是:进行一次聚焦的更新,其中包含与所选范围相匹配的示例或链接。
由索引模型根据 Issue 内容生成。
描述
For @knz
I was looking through the docs trying to find out how to register a migrated error, and it took me a little bit. So I wanted to suggest how to make that more visible, and then I thought while I'm at it, a couple more suggestions:
- First, the docs on migrating/renaming an error are a little buried and could perhaps be linked in the README. You talk about forward compatibility in the README, which I understand in part to involve forwarding errors through unaware intermediaries but from the name it sounds like error migration is part of it, so I was surprised how much I had to dig to re-find this data.
-
RegisterTypeMigrationcould perhaps be part of the "forwarded methods" so it shows up in the main package, looks like I currently need to importerrbaseto get at it. - The README could use a sample of the ultra-awesome stack trace format!
- The compatibility table is a bit intense to be at the top of the README. I remember back when I first came across this package, it was a little confusing—my takeaway was, "wow, this thing has lots of features I guess". I feel like you might be better served by having the top of the README dedicated to a simple bullet-point list of features and some code samples showing what it looks like in practice.
- Could have a godoc badge up at the top of the README:
- Perhaps rethink how the data on custom errors is provided. The information is pretty dense and unstructured; I would suggest more subheadings for specific tasks like "Custom Leaf", "Custom Wrapper", "Over the Network", or some such. Also perhaps consider putting the writeup in its own document because there's a lot to the subject and it can be overwhelming to someone landing on the main page of the repo.
- This is subjective, but I think in general the README could express more through code samples:
- The section on Available Error Leaves could show little fake error scenarios, using that applicable function, and then retrieving the data, with additional details in comments.
- The section How to Use could perhaps be shown in code.
- I question the necessity of API (not constructing error objects), since Godoc is probably better suited for this anyway.
- I don't think the
exthttppackage is mentioned as a useful tool, more as an example for when you're building your own error types, but I think it adds value. Alsoextgrpcisn't mentioned, although that one's entirely my fault because I never added docs for the work I did 😉 - I feel like the project deserves a cool logo! (😄 ) Maybe a variation of the cockroachdb logo?
I'm aware that I'm armchair-quarterbacking and should probably put a PR where my mouth is, but I'm in the middle of other things and just felt compelled to jot down some notes. Interested to hear your thoughts!
- 主要语言
- Go
- 星标
- 2.5k
- 派生
- 75
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
cockroachdb/errors 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 52/100
cockroachdb/errors#162 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 48/100
cockroachdb/errors#156 · 20 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 30/100
cockroachdb/errors#155 · 1 条评论 · 1 个 reaction ·
-
难度 4/5 3-5 天 新手友好度 35/100
cockroachdb/errors#146 ·
-
难度 4/5 3-5 天 新手友好度 35/100
cockroachdb/errors#145 · 1 条评论 · 1 个 reaction ·
查看 cockroachdb/errors 的全部 Issue
相似的 Issue
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 1/5 1 小时以内 新手友好度 85/100
-
难度 2/5 1-3 小时 新手友好度 75/100
-
kind/bug status/0-triage
难度 2/5 1-3 小时 新手友好度 75/100
-
🤔 refinement needed
难度 2/5 1-3 小时 新手友好度 75/100
equinor/radix-operator#1979 ·