Skip to content

Commit 088ce58

Browse files
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 <[email protected]> * Update docs/src/creating-packages.md --------- Co-authored-by: Ian Butterworth <[email protected]>
1 parent 621740f commit 088ce58

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/src/creating-packages.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -620,6 +620,11 @@ may fit your package better.
620620
library, even without explicit affiliation with the creators of the OpenSSL (provided
621621
there's no copyright or trademark infringement etc.)
622622

623+
9. Packages should follow the [Stylistic Conventions](https://docs.julialang.org/en/v1/manual/variables/#Stylistic-Conventions).
624+
* The package name begin with a capital letter and word separation is shown with upper camel case
625+
* Packages that provide the functionality of a project from another language should use the Julia convention
626+
* 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.
627+
623628
## Registering packages
624629

625630
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)).

0 commit comments

Comments
 (0)