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 摘要。