diff options
Diffstat (limited to 'doc/contributing.rst')
| -rw-r--r-- | doc/contributing.rst | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index e6301faae..ba9c1caf3 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -599,14 +599,16 @@ to existing modules is acceptable. For two reasons: Conventions ----------- -1. New stdlib modules should go under `Nim/lib/std/`. The rationale is to require -users to import via `import std/foo` instead of `import foo`, which would cause -potential conflicts with nimble packages. Note that this still applies for new modules -in existing logical directories, e.g.: -use `lib/std/collections/foo.nim`, not `lib/pure/collections/foo.nim`. +1. New stdlib modules should go under `Nim/lib/std/`. The rationale is to + require users to import via `import std/foo` instead of `import foo`, + which would cause potential conflicts with nimble packages. + Note that this still applies for new modules in existing logical + directories, e.g.: use `lib/std/collections/foo.nim`, + not `lib/pure/collections/foo.nim`. 2. New module names should prefer plural form whenever possible, e.g.: -`std/sums.nim` instead of `std/sum.nim`. In particular, this reduces chances of conflicts -between module name and the symbols it defines. Furthermore, module names should -use `snake_case` and not use capital letters, which cause issues when going -from an OS without case sensitivity to an OS with it. + `std/sums.nim` instead of `std/sum.nim`. In particular, this reduces + chances of conflicts between module name and the symbols it defines. + Furthermore, module names should use `snake_case` and not use capital + letters, which cause issues when going from an OS without case + sensitivity to an OS with it. |