Skip to content

Commit 0f7f58e

Browse files
authored
Update naming scheme wiki entry. (#139)
We had a capitalization scheme wiki entry, but hadn't documented our standard of using underscores instead of dashes for multi-word package names. This PR converts the capitalization scheme into a naming scheme, which also documents the underscore usage. For some historic discussion there's e.g. [this Zulip thread](https://xi.zulipchat.com/#narrow/stream/354396-xilem/topic/.E2.9C.94.20Crate.20naming). Otherwise, there's just the fact that all our modern packages are named as such, e.g. `vello_hybrid`, `masonry_core`, etc.
1 parent d3c034e commit 0f7f58e

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

content/wiki/capitalization_scheme.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

content/wiki/naming_scheme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
+++
2+
title = "Naming scheme for Linebender projects"
3+
+++
4+
5+
All Linebender projects should follow this naming scheme:
6+
7+
- The project name uses title case and spaces for word separation, e.g. *Vello* or *Vello Hybrid*.
8+
- The package name uses lower case and underscores for word separation, e.g. `vello` or `vello_hybrid`.
9+
- When referring to the package, e.g. in relation to crates.io, use backticks to put the name in a codeblock, e.g. `vello`.
10+
- When referring to the GitHub repository, make it a link, e.g. [vello#1](https://github.com/linebender/vello/pull/1).
11+
12+
Feel free to correct any documentation you see that doesn't yet follow this scheme, unless the project is explicitly discontinued or in maintenance mode (eg Xi-Editor, Piet).

0 commit comments

Comments
 (0)