Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Documentation for JSON formats (automata and test cases)

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#256 0 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
json, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách tìm các tệp JSON của automaton và test case, hoặc đoạn mã tải chúng, để xác định các định dạng; issue đưa ra ví dụ về test case có mảng tests và các trường id, string, expectedAccept. Tài liệu hóa cả hai cấu trúc và bao gồm các tệp JSON mẫu. Hoàn thành khi người đọc có thể hiểu các định dạng và tạo tệp test case theo tài liệu.

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

Mô tả

documentation enhancement

I don't believe we have the structure for our automaton or test case JSON files documented anywhere. This is especially an issue for the test cases, because there is currently no way to export a JSON file from the editor. As a result, the only way to create test cases is to know the JSON format beforehand and write one by hand. For reference I was able to write the following file and have the program use it:

{
    "tests": [
        {
            "id": "test1",
            "string": "aaa",
            "expectedAccept": true
        },
        {
            "id": "test2",
            "string": "b",
            "expectedAccept": true
        }
    ]
}

Having example JSON files as well as documentation explaining their structure would be very helpful for further development.

Ngôn ngữ chính
TypeScript
Star
1
Fork
23
Merge trung bình
3 ngày 7 giờ
Pull request đã merge (30 ngày)
7

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 AutomatonBuilderGUI/AutomatonBuilderGUI

Tất cả issue của AutomatonBuilderGUI/AutomatonBuilderGUI

Issue tương tự

Thêm issue về TypeScript

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.