Add a GraphQL ecosystem profile

Đang mở
  • Có gì không ổn?
#89 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
graphql, python
Lĩnh vực
testing, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Python
Star
4
Fork
1
Merge trung bình
10 giờ 41 phút
Pull request đã merge (30 ngày)
79

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của cpp-best-practices/project_validator

Tất cả issue của cpp-best-practices/project_validator

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.