diff --git a/content/wiki/capitalization_scheme.md b/content/wiki/capitalization_scheme.md deleted file mode 100644 index 2830db38..00000000 --- a/content/wiki/capitalization_scheme.md +++ /dev/null @@ -1,13 +0,0 @@ -+++ -title = "Capitalization scheme for Linebender projects" -+++ - -All Linebender projects should follow this capitalization scheme: - -- The project's name should start with an uppercase letter when referring to the project itself, eg Vello. -- The name should be all-lowercase where referring to the project as a Rust crate (for instance, in relation to crates.io). -In that case, it's encouraged to use backticks to put the project name in a codeblock, eg `vello`. -- The name should be all-lowercase where referring to the project as a GitHub repository. -In that case, it's encouraged to either use backticks or make it a link, eg [vello#1](https://github.com/linebender/vello/pull/1). - -Feel free to correct any documentation you see to follow this scheme, unless the project is explicitly discontinued or in maintenance mode (eg Xi-Editor, Piet). diff --git a/content/wiki/naming_scheme.md b/content/wiki/naming_scheme.md new file mode 100644 index 00000000..e7d8ea01 --- /dev/null +++ b/content/wiki/naming_scheme.md @@ -0,0 +1,12 @@ ++++ +title = "Naming scheme for Linebender projects" ++++ + +All Linebender projects should follow this naming scheme: + +- The project name uses title case and spaces for word separation, e.g. *Vello* or *Vello Hybrid*. +- The package name uses lower case and underscores for word separation, e.g. `vello` or `vello_hybrid`. +- When referring to the package, e.g. in relation to crates.io, use backticks to put the name in a codeblock, e.g. `vello`. +- When referring to the GitHub repository, make it a link, e.g. [vello#1](https://github.com/linebender/vello/pull/1). + +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).