Add a GraphQL ecosystem profile

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
graphql, python
领域
testing, tooling

调研方向

Read the existing ecosystem profiles, especially tests/test_go.py, and the contract in tests/test_ecosystem_contract.py; inspect tests/support.py for fixture layout and tests/test_documentation.py for the README table. Add the profile at project_validator/ecosystems/graphql.py, register it in BUILT_IN, and add the named fixtures and tests. Done means the configured fixture passes applicable checks, the bare fixture passes none, snapshots are recorded, and the README lists where the profile applies.

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

描述

Profile

Recognised by schema files: *.graphql / *.graphqls containing type definitions, or schema.graphql (#63). Supplies the schema practices from #85.

Practice Rule for this ecosystem
schema-validation CI validates operations against the schema: graphql-inspector validate, or codegen that fails on invalid documents
compiler-warnings graphql-schema-linter or @graphql-eslint in CI
code-formatting prettier (default style)
schema-compatibility graphql-inspector diff (or Apollo rover graph check) in CI

Definition of done

  • One profile module, project_validator/ecosystems/graphql.py, registered in BUILT_IN. Nothing in project_validator/checks/ changes: a row marked later belongs to a check that does not exist yet and is recorded on that check's issue.
  • tests/fixtures/well_configured_graphql passes every check that applies to it, and tests/fixtures/bare_graphql passes none of the ecosystem's practices (tests/test_ecosystem_contract.py). Snapshots recorded with UPDATE_SNAPSHOTS=1.
  • A project layout in tests/support.py, profile tests like tests/test_go.py, and the README "Applies to" column (tests/test_documentation.py).
  • A practice with no good evidence for this ecosystem is left out (the check reports SKIP) rather than judged by weak evidence.
主要语言
Python
星标
4
派生
1
平均合并
10 小时 41 分钟
30 天内合并 PR
79

环境准备

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

从这里开始

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

cpp-best-practices/project_validator 的其他 Issue

查看 cpp-best-practices/project_validator 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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