Add a quickstart guide to documentation
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript
调研方向
找到用户指南,并检查当前如何记录 package 安装和导入。添加一个简短的 quickstart,涵盖 npm 安装、package.json 配置、导入和使用 crypto-browserify,以及对 "crypto" namespace 的必要处理。完成的标准是新用户能够获得明确且可用的设置说明。
由索引模型根据 Issue 内容生成。
描述
For new users transitioning to crypto-browserify (for example due to recent create-react-scripts 5 breakage), it would be really helpful if the user guide had a small example of how to:
- Install
crypto-browserifyand configurepackage.json - How to import and use the package
For example, treating this like a normal npm package, I expected that this could work:
"dependencies": {
"crypto-browserify": "^3.12.0",
import hash from "crypto-browserify";
But it does not. Likely this needs to be patched over the "crypto" namespace, but having explicit instructions for this would be helpful.
- 主要语言
- JavaScript
- 星标
- 681
- 派生
- 209
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
browserify/crypto-browserify 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 35/100
browserify/crypto-browserify#255 · 1 个 reaction ·
-
难度 1/5 1 小时以内 新手友好度 35/100
browserify/crypto-browserify#250 · 1 条评论 ·
-
难度 5/5 一周以上 新手友好度 30/100
browserify/crypto-browserify#240 ·
-
难度 4/5 3-5 天 新手友好度 35/100
browserify/crypto-browserify#238 · 3 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
browserify/crypto-browserify#232 · 6 条评论 ·
查看 browserify/crypto-browserify 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
thedevs-network/kutt#1059 ·
-
good first issue help wanted
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 1/5 1 小时以内 新手友好度 82/100
维护者通常 1 天内回复
-
0. Needs triage 35-feedback bug
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复