You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en.md
+44-2Lines changed: 44 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,18 +75,36 @@ For each issue, please try to:
75
75
76
76
For example, typing Chinese characters requires an IME. You can link to [Unicode FAQ on Chinese and Japanese](https://unicode.org/faq/han_cjk.html).
77
77
78
-
79
78
But in most cases:
80
79
81
80
- No need to provide a solution directly
82
81
83
82
Just link it as `#workaround("https://…")`.
84
83
85
-
86
84
- No need to describe comprehensively, nor is it recommended to propose improvements too much
87
85
88
86
These contents can be initially proposed at [GitHub Issues](https://github.com/typst-doc-cn/clreq/issues/), and should eventually be forwarded to the Typst official.
89
87
88
+
### Maintaining
89
+
90
+
GitHub Actions are watching `#issue` and `#pull` annotated in the document, and will report in [🤖 Cron check · Issue #22](https://github.com/typst-doc-cn/clreq/issues/22) and pull request if their states changes.
91
+
92
+
We can update the document once we notice. There is no need to wait until Typst releases a new version.
- The `en` and `zh` fields are displayed in English and 中文 modes, respectively.
@@ -112,6 +130,30 @@ Tips:
112
130
113
131
- Don’t pay special attention to line breaks and indentation. Just use tinymist (VS Code) / typstyle default settings. To make version comparison easier, we have set up a pull request robot to automatically format them.
114
132
133
+
### Title formats
134
+
135
+
- Top-level sections representing **categories**
136
+
137
+
The title should be as consistent as possible with [W3C Gap Analysis documents](https://www.w3.org/TR/clreq-gap/).
0 commit comments