From 088ce58a5589c2fcd4a8c433dd7615006cab4072 Mon Sep 17 00:00:00 2001 From: Ronny Bergmann Date: Fri, 30 Aug 2024 17:57:06 +0200 Subject: [PATCH] Update naming conventions for packages (#4003) * Update creating-packages.md Add a comment about capitalisation and Camel case conventions of packages. * Update docs/src/creating-packages.md Co-authored-by: Ian Butterworth * Update docs/src/creating-packages.md --------- Co-authored-by: Ian Butterworth --- docs/src/creating-packages.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/src/creating-packages.md b/docs/src/creating-packages.md index 4959260733..1546cdad11 100644 --- a/docs/src/creating-packages.md +++ b/docs/src/creating-packages.md @@ -620,6 +620,11 @@ may fit your package better. library, even without explicit affiliation with the creators of the OpenSSL (provided there's no copyright or trademark infringement etc.) +9. Packages should follow the [Stylistic Conventions](https://docs.julialang.org/en/v1/manual/variables/#Stylistic-Conventions). + * The package name begin with a capital letter and word separation is shown with upper camel case + * Packages that provide the functionality of a project from another language should use the Julia convention + * Packages that [provide pre-built libraries and executables](https://docs.binarybuilder.org/stable/jll/) can keep orignal name, but should get `_jll`as a suffix. For example `pandoc_jll` wraps pandoc. However, note that the generation and release of most JLL packages is handled by the [Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil) system. + ## Registering packages Once a package is ready it can be registered with the [General Registry](https://github.com/JuliaRegistries/General#registering-a-package-in-general) (see also the [FAQ](https://github.com/JuliaRegistries/General#faq)).