graphql / graphql/graphql.github.io

Create naming best practices page

未关闭
#2,013 1 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
TypeScript
星标
889
派生
1.5k
平均合并
4 天 12 小时
30 天内合并 PR
21

描述

Naming is always the hardest thing but there are some established conventions for naming in the GraphQL community, see:

Other languages also have their own code style/conventions:

Feels like having official guidance on graphql.org would be a win for the community.

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先审阅 GraphQL 命名指南以及链接的 GraphQL、Rust、Kotlin 和 Go 约定。然后检查 graphql.org 的文档结构,以确定该页面应放置的位置;完成的标准是发布一个包含已达成共识且组织清晰的指导内容的命名最佳实践页面。

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

评估

技术栈
graphql
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

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