Add `implementedBy` field in `metadata.yml`

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

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
graphql
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với metadata.yml, bốn biểu diễn implementedBy được đề xuất và danh sách định nghĩa các dự án được liên kết. So sánh khả năng hỗ trợ các dự án có tên và plugin tùy ý, sau đó xác nhận schema đã chọn và dạng metadata dự kiến; công việc hoàn tất khi định dạng được quyết định và được ghi tài liệu nhất quán.

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

Mô tả

@PascalSenn suggested at today's wg meeting that GAPs should list (in metadata.yml) what servers/clients implement the spec, so users can decide which spec to use.

Option 1 - text only

implementedBy:
  - "Apollo Client >= v1.2.3"
  - "Relay >= v3.4.5"

Option 2 - markdown links

implementedBy:
  - [Apollo Client >= v1.2.3](https://www.apollographql.com/docs/react)
  - [Relay >= v3.4.5](https://github.com/facebook/relay)

Option 3 - structured data

implementedBy:
  - name: Apollo Client
    website: https://www.apollographql.com/docs/react
    version: 1.2.3
  - name: Relay
    website: https://www.apollographql.com/docs/react
    version: 3.4.5

Option 4 - project definition keys + structured data

implementedBy:
  - project: apollo-client
    version: 1.2.3
  - project: relay
    version: 3.4.5

...which refers to some central projects.yml that looks like this:

- id: apollo-client
  website: https://www.apollographql.com/docs/react
- id: relay
  website: https://github.com/facebook/relay

Maybe this can reuse the definitions list here https://caniuse.graphql.now/index.html#projects

Note: I'd also like to support arbitrary projects here too, since support might initially be implemented as random a plugin (e.g. the @mock spec is currently implemented in apollo-client-mock-directive-plugin, not apollo core. I would expect many specs might start out this way.

So that implies something like this:

implementedBy:
  - project: relay
    version: 3.4.5
  - name: apollo-client-mock-directive-plugin
    website: https://github.com/magicmark/apollo-client-mock-directive-plugin/
    version: 0.0.1

my vote is Option 4.

Ngôn ngữ chính
JavaScript
Star
10
Fork
8
Không có pull request nào được merge trong 30 ngày

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

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 graphql/gaps

Tất cả issue của graphql/gaps

Issue tương tự

Thêm issue về JavaScript

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.