adamchalmers / adamchalmers/fountain-rs

Implement `Notes` element

Đang mở
#1 2 bình luận 1 reaction 0 người được giao Xem trên GitHub
enhancement good first issue
Ngôn ngữ chính
Rust
Star
25
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Fountain has a "Notes" element (definition [here](https://fountain.io/syntax#section-notes)) which styles author's notes in the screenplay, so it's clear these are authors notes and not action.

Someone should implement this!

Acceptance criteria (A/C):

- Add a `Note` variant to the [Line](https://docs.rs/fountain/0.1.12/fountain/data/enum.Line.html) enum
- Add a parser for it to [parse.rs](https://github.com/adamchalmers/fountain-rs/blob/master/fountain/src/parse.rs) and call the parser in the [`block` parser](https://github.com/adamchalmers/fountain-rs/blob/master/fountain/src/parse.rs#L171-L188)
- Add a unit test

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Start by reading the Line enum documentation and fountain/src/parse.rs, especially the block parser at lines 171-188, along with Fountain's section-notes syntax definition. Add the Note variant, connect its parser in the block parser, and add a unit test demonstrating the Notes element is parsed; done means all tests pass.

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

Đánh giá

Công nghệ
rust
Lĩnh vực
tooling
Loại issue
Tính năng
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
52/100

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.