API Documentation Detail
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ài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- graphql
- Lĩnh vực
- api, databases, documentation, testing
Hướng nghiên cứu
Bắt đầu bằng cách lập danh mục các lĩnh vực tài liệu được yêu cầu: migration và dump cơ sở dữ liệu, quy ước đặt tên db, buildQuery, wrangler.toml và script scraper, các endpoint REST và GraphQL, và việc kiểm thử. Xem lại site docs hiện có và vị trí các trang docs trước khi viết. Công việc được xem là hoàn tất khi workflow được tài liệu hóa bao quát từ các thay đổi cơ sở dữ liệu đến việc kiểm thử endpoint, bao gồm các mã lỗi, ví dụ, tệp đã thay đổi và các khu vực cần chú ý.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
DB Design / Changes:
- db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
- db naming conventions
- buildQuery
Scraper:
- documentation on understanding wrangler.toml files, how scrapers work, what to expect from them
Endpoint:
- error codes and meanings GOOD PRACTICE - along with endpoint info.
- rest endpoint
- all files changed
- areas of focus, things to look out for
- what a typical change entails
- graphql
- difference between rest and graphql
- example of implementation
- where to test on docs page
Testing:- testing throughout the process [db change -> endpoint]
- Ngôn ngữ chính
- MDX
- Star
- 0
- Fork
- 1
- Merge trung bình
- 23 ngày 5 giờ
- Pull request đã merge (30 ngày)
- 1
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của icssc/docs
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 45/100
-
OG Images 404Có thể làm lại được @alexanderl19 đã nhận 639 ngày trước và không có pull request nào đang mở. Đang mởbug
-
Deploys & Staging PreviewsCó thể làm lại được @andrew-wang0 đã nhận 640 ngày trước và không có pull request nào đang mở. Đang mở
-
Add Page DescriptionsCó thể làm lại được @alexanderl19 đã nhận 696 ngày trước và không có pull request nào đang mở. Đang mở
-
Centralized Calendar API Reference and ArchitectureCó thể đã có người làm @spicecat đã nhận 865 ngày trước. Đang mởdocs:addition
Issue tương tự
-
rtdb-info-connected-order test: unhandled 'connection is closed' rejection fails the CLI suiteĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Source item status is not saved when stock is deducted on shipment (stays "In Stock" at qty 0)Đang mởIssue: ready for confirmation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Optimize consumer version heatmap aggregation to avoid repeated scansCó thể đã có người làm @praykaria31 đã nhận hôm nay. Đang mởtype/enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Apicurio/apicurio-registry#10662 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Bug]: Auto-uploaded local files get names containing the local path (extension taken from the whole path)Có thể đã có người làm @r2jaff đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
ComposioHQ/composio#5052 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Maintainer thường phản hồi trong vòng 1 ngày