Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Add Proper Documentation, Links and Subgraphs Mermaid Diagram to the Readme File

未关闭
#20 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

首先阅读 readme.md,并检查现有的项目结构和 subgraph schema。记录项目描述、复现和使用步骤、相关的 Graph Protocol 链接和合约地址,以及已部署 subgraph 的链接;然后添加一个表示该 schema 的 Mermaid 图表。

由索引模型根据 Issue 内容生成。

描述

Suggested Improvements to the current repo readme.md file
  • Add the description of the projects and the steps required to reproduce it and use it
  • Add the associated links and the contract addresses used for the graph protocol
  • Add the link of the subgraph that is deployed
  • Add a mermaid diagram representing the subgraph's schema. For more information about mermaid files checkout https://mermaid-js.github.io/mermaid/
主要语言
TypeScript
星标
54
派生
14
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Developer-DAO/Lens-Graph-Subgraph 的其他 Issue

查看 Developer-DAO/Lens-Graph-Subgraph 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。