|
1 | 1 | # Contributing Guidelines |
2 | 2 | Contributions are welcome! This document provides some resources and guidelines to help with the process. |
3 | 3 |
|
4 | | -Symbol definitions are in `src/modules/`; The syntax should be mostly self-evident. |
5 | | -If you need help with a contribution, you can ask us [on Discord](https://discord.com/channels/1054443721975922748/1277628305142452306). |
| 4 | +Codex collects related Unicode symbols as different *variants* of the same *symbol*.[^symbol] |
| 5 | +For example, `→ ⇒ ↑ ⇑` are four variants of the `arrow` symbol. |
| 6 | +Each symbol has a default variant (here `→`). |
| 7 | +To refer to a particular variant, *modifiers* can be appended to the symbol name |
| 8 | +using dot separators. |
| 9 | +For example `⇒` is `arrow.double`, `↑` is `arrow.t` and `⇑` is `arrow.double.t`. |
| 10 | +Modifiers are order-independent, so the latter can also be referred to as `arrow.t.double`. |
| 11 | +Groups of related symbols are collected into *modules*. Modules can also contain other modules. |
| 12 | +Codex exports two main modules: `sym` for for text-style symbols and `emoji` for emoji; |
| 13 | +Their source code is found in `src/modules/`. |
| 14 | + |
| 15 | +If you need help with a contribution, you can also ask us [on Discord](https://discord.com/channels/1054443721975922748/1277628305142452306). |
6 | 16 |
|
7 | 17 | Proposals used to be written in a dedicated Proposals document, |
8 | 18 | but new proposals should now be filed as GitHub issues instead. |
9 | 19 | The [document](https://typst.app/project/riXtMSim5zLCo7DWngIFbT) |
10 | 20 | has been repurposed to serve as a collection of useful information |
11 | 21 | and naming ideas. |
12 | 22 |
|
| 23 | +[^symbol]: This document also uses "symbol" in the more abstract sense of a graphical symbol. |
| 24 | + |
13 | 25 | ## Conventions |
14 | 26 | When adding new modules, symbols or variants, please try to be consistent with |
15 | 27 | existing ones. Below are some guidelines based on existing symbols. These aren't |
|
0 commit comments